status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

Updating documentation of realmAtPath
This commit is contained in:
Brian Munkholm 2017-11-02 04:44:43 -07:00 committed by GitHub
parent 5caf1d8b81 d858c4e87a
commit ebedb93edb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

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

9
docs/sync.js
View File

@ -21,9 +21,9 @@
* migrated to the v2.x format. In case this migration * 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 * 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` * 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. * copy objects to a new synced Realm.
* *
* @memberof Realm * @memberof Realm
*/ */
class Sync { class Sync {
@ -153,7 +153,7 @@ class IncompatibleSyncedRealmError {
* The name of the error is 'IncompatibleSyncedRealmError' * The name of the error is 'IncompatibleSyncedRealmError'
*/ */
get name() {} get name() {}
/** /**
* The {Realm~Configuration} of the backed up Realm. * The {Realm~Configuration} of the backed up Realm.
* @type {Realm~Configuration} * @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 * 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` * 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 {string} path - the path for the Realm to open
* @param {Realm~ObjectSchema[]} [optional] schema - schema to apply when opening the Realm
* @returns {Realm} * @returns {Realm}
*/ */
realmAtPath(path) {} realmAtPath(path, schema) {}
/** /**
* Close the adapter and all opened Realms. * 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; advance(path: string): void;
close(): void; close(): void;
current(path: string): Array<Instruction>; current(path: string): Array<Instruction>;
realmAtPath(path: string, realmID?: string, schema?: ObjectSchema[]): Realm realmAtPath(path: string, schema?: ObjectSchema[]): Realm
} }
} }