NOTE: Support for syncing with realm.cloud.io and/or Realm Object Server has been replaced with support for syncing with MongoDB Realm Cloud.
NOTE: This version bumps the Realm file format to version 11. It is not possible to downgrade to earlier versions. Older files will automatically be upgraded to the new file format. Files created by Realm JavaScript prior to v1.0.0, might not be upgradeable. Only Realm Studio 10.0.0 or later will be able to open the new file format.
Breaking changes
Realm.Auth.EmailPassword.registerEmail()
has been renamed toRealm.Auth.EmailPassword.registerUser()
.Realm.User.identity
has been renamed toRealm.User.id
.Realm.User.token
has been renamed toRealm.User.accessToken
.- Change instance methods
Realm.App.currentUser()
andRealm.App.allUsers()
to instance propertiesRealm.App.currentUser
andRealm.App.allUsers
. Realm.Auth.UserAPIKeyProvider
has been replaced byRealm.Auth.ApiKeyProvider
.user.auth.apiKeys
has been replaced byuser.apiKeys
.- The instance methods on the ApiKeyAuth instance (
user.apiKeys
) have gotten their APIKey(s) suffix removed: Ex.apiKeys.createAPIKey
has been replaced byapiKeys.create
. Realm.Auth.EmailPasswordProvider
has been replaced byRealm.Auth.EmailPasswordAuth
.app.auth.emailPassword
has been replaced byuser.emailPasswordAuth
.Credentials.userAPIKey
has been replaced byCredentials.userApiKey
.Credentials.serverAPIKey
has been replaced byCredentials.serverApiKey
.
Enhancements
- Added RemoteMongoClient functionality to
Realm.User
- Added
watch()
toRemoteMongoDBCollection
to enable streaming notifications of changes events from the database. Only supported in node.js for now. - Throwing more descriptive messages when parsing schema properties
Fixed
- Failed to parse arguments correctly, causing the error
callback must be of type 'function', got (undefined)
when callingRealm.App.emailPassword.sendResetPasswordEmail()
andRealm.App.emailPassword.resendConfirmationEmail()
. (#3037, since v10.0.0-beta.1) - Fixed
user.logOut()
to also log out at MongoDB Realm Cloud. The method now returnsPromise<void>
instead. (#2980, since v10.0.0-beta.1) - Fixed
TypeError: process.versions is not an Object
error being thrown when requiring the package from React Native. (#3045, since v10.0.0-beta.8) - Fixed duplicated TypeScript definition of
Realm.objectForPrimaryKey()
. (#2940, since v10.0.0-beta.1)
Compatibility
- MongoDB Realm Cloud.
- APIs are backwards compatible with all previous releases of Realm JavaScript in the 10.x.y series.
- File format: generates Realms with format v11 (reads and upgrades file format v5 or later).