Updating documentation of realmAtPath

This commit is contained in:
Kenneth Geisshirt 2017-11-01 14:44:40 +01:00
parent 973959174d
commit d858c4e87a
3 changed files with 7 additions and 5 deletions

View File

@ -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.

View File

@ -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.

2
lib/index.d.ts vendored
View File

@ -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
}
}