Merge pull request #1452 from realm/kneth/remove-unused-argument-from-realmAtPath

Updating documentation of realmAtPath

CHANGELOG.md

@@ -8,6 +8,7 @@ X.Y.Z Release notes
 
 ### Bug fixea
 * Fixed missing Realm constructor in while debugging React Native apps (#1436).
+* Remove argument in documentation of `Realm.Sync.Adapter.realmAtPath()`.
 
 ### Internal
 * None.

docs/sync.js

@@ -21,9 +21,9 @@
  * migrated to the v2.x format. In case this migration
  * is not possible, an exception is thrown. The exception´s `message` property will be equal
  * to `IncompatibleSyncedRealmException`. The Realm is backed up, and the property `configuration`
- * is a {Realm~Configuration} which refers to it. You can open it as a local, read-only Realm, and 
+ * is a {Realm~Configuration} which refers to it. You can open it as a local, read-only Realm, and
  * copy objects to a new synced Realm.
- * 
+ *
  * @memberof Realm
  */
 class Sync {
@@ -153,7 +153,7 @@ class IncompatibleSyncedRealmError {
      * The name of the error is 'IncompatibleSyncedRealmError'
      */
     get name() {}
-    
+
     /**
      * The {Realm~Configuration} of the backed up Realm.
      * @type {Realm~Configuration}
@@ -433,9 +433,10 @@ class Adapter {
 	 * Open the Realm used by the Adapter for the given path. This is useful for writing two way
 	 * adapters as transactions written to this realm will be ignored when calling `current` and `advance`
 	 * @param {string} path - the path for the Realm to open
+     * @param {Realm~ObjectSchema[]} [optional] schema - schema to apply when opening the Realm
 	 * @returns {Realm}
 	 */
-	realmAtPath(path) {}
+	realmAtPath(path, schema) {}
 
 	/**
 	 * Close the adapter and all opened Realms.

lib/index.d.ts

@@ -439,7 +439,7 @@ declare namespace Realm.Sync {
         advance(path: string): void;
         close(): void;
         current(path: string): Array<Instruction>;
-        realmAtPath(path: string, realmID?: string, schema?: ObjectSchema[]): Realm
+        realmAtPath(path: string, schema?: ObjectSchema[]): Realm
     }
 }