From d858c4e87a4bc9c88b3ff3272d4d2c185917bff9 Mon Sep 17 00:00:00 2001 From: Kenneth Geisshirt Date: Wed, 1 Nov 2017 14:44:40 +0100 Subject: [PATCH] Updating documentation of realmAtPath --- CHANGELOG.md | 1 + docs/sync.js | 9 +++++---- lib/index.d.ts | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b1316b2c..6be4ee9d 100644 --- a/CHANGELOG.md +++ b/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. diff --git a/docs/sync.js b/docs/sync.js index e33e2f93..6a3e8b8b 100644 --- a/docs/sync.js +++ b/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. diff --git a/lib/index.d.ts b/lib/index.d.ts index 981d28ca..3b86e140 100644 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -439,7 +439,7 @@ declare namespace Realm.Sync { advance(path: string): void; close(): void; current(path: string): Array; - realmAtPath(path: string, realmID?: string, schema?: ObjectSchema[]): Realm + realmAtPath(path: string, schema?: ObjectSchema[]): Realm } }