Deprecated setFeatureToken(). (#1694)

CHANGELOG.md

@@ -23,6 +23,7 @@
   - Method `Realm.privilges()` to compute privileges on a Realm, a Realm object schema, or a Realm object. The method returns either a `Realm.Permissions.Realm` or `Realm.Permissions.Class` object.
   - For non-synced Realms, all privileges are always granted.
   - For more details, please read the reference documentation.
+* [Sync] Decrepated `Realm.Sync.setFeatureToken` (#1689).
 
 ### Internal
 * Updated to Realm Core 5.3.0.

lib/extensions.js

@@ -151,11 +151,7 @@ module.exports = function(realmConstructor) {
 
         if (realmConstructor.Sync._setFeatureToken) {
             realmConstructor.Sync.setFeatureToken = function(featureToken) {
-                if (typeof featureToken !== 'string' && !(featureToken instanceof String)) {
-                    throw new Error("featureToken should be a string");
-                }
-
-                realmConstructor.Sync._setFeatureToken(featureToken.trim());
+                console.log('Realm.Sync.setFeatureToken() is deprecated and you can remove any calls to it.');
             }
         }
 

lib/index.d.ts

@@ -448,6 +448,10 @@ declare namespace Realm.Sync {
     function removeListener(regex: string, name: string, changeCallback: (changeEvent: ChangeEvent) => void): Promise<void>;
     function setLogLevel(logLevel: 'all' | 'trace' | 'debug' | 'detail' | 'info' | 'warn' | 'error' | 'fatal' | 'off'): void;
     function initiateClientReset(path: string): void;
+
+    /**
+     * @deprecated, to be removed in future versions
+     */
     function setFeatureToken(token: string): void;
 
     type Instruction = {