status-im/realm-js
2
0
Fork 0
mirror of https://github.com/status-im/realm-js.git synced 2025-01-11 14:54:33 +00:00
Code Issues Projects Releases Wiki Activity

add typescript definitions

Browse Source
This commit is contained in:
blagoev 2017-09-05 17:04:06 +03:00
parent 3a8f56cdc0
commit e5ebb75d22
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lib/index.d.ts vendored
View File

@ -332,6 +332,9 @@ declare namespace Realm.Sync {
ssl_trust_certificate_path?: string; ssl_trust_certificate_path?: string;
} }
type ProgressNotificationCallback = (transferred: number, total: number) => void;
type ProgressDirection = 'download' | 'upload';
type ProgressMode = 'reportIndefinitely' | 'forCurrentlyOutstandingWork';
/** /**
* Session * Session
* @see { @link https://realm.io/docs/javascript/latest/api/Realm.Sync.Session.html } * @see { @link https://realm.io/docs/javascript/latest/api/Realm.Sync.Session.html }
@ -341,6 +344,9 @@ declare namespace Realm.Sync {
readonly state: 'invalid' | 'active' | 'inactive'; readonly state: 'invalid' | 'active' | 'inactive';
readonly url: string; readonly url: string;
readonly user: User; readonly user: User;
addProgressNotification(direction: ProgressDirection, mode: ProgressMode, progressCallback: ProgressNotificationCallback): void;
removeProgressNotification(progressCallback: ProgressNotificationCallback): void;
} }
/** /**
@ -402,6 +408,11 @@ declare namespace Realm.Sync {
} }
} }
interface ProgressPromise extends Promise<Realm> {
progress(callback: Realm.Sync.ProgressNotificationCallback) : Promise<Realm>
}
declare class Realm { declare class Realm {
static defaultPath: string; static defaultPath: string;
@ -422,17 +433,20 @@ declare class Realm {
*/ */
static schemaVersion(path: string, encryptionKey?: ArrayBuffer | ArrayBufferView): number; static schemaVersion(path: string, encryptionKey?: ArrayBuffer | ArrayBufferView): number;
/** /**
* Open a realm asynchronously with a promise. If the realm is synced, it will be fully synchronized before it is available. * Open a realm asynchronously with a promise. If the realm is synced, it will be fully synchronized before it is available.
* @param {Configuration} config * @param {Configuration} config
*/ */
static open(config: Realm.Configuration): Promise<Realm> static open(config: Realm.Configuration): ProgressPromise;
/** /**
* Open a realm asynchronously with a callback. If the realm is synced, it will be fully synchronized before it is available. * Open a realm asynchronously with a callback. If the realm is synced, it will be fully synchronized before it is available.
* @param {Configuration} config * @param {Configuration} config
* @param {ProgressNotificationCallback} progressCallback? a progress notification callback for 'download' direction and 'forCurrentlyOutstandingWork' mode
* @param {Function} callback will be called when the realm is ready. * @param {Function} callback will be called when the realm is ready.
*/ */
static openAsync(config: Realm.Configuration, callback: (error: any, realm: Realm) => void): void static openAsync(config: Realm.Configuration, progressCallback?: Realm.Sync.ProgressNotificationCallback, callback: (error: any, realm: Realm) => void): void
/** /**
* Delete the Realm file for the given configuration. * Delete the Realm file for the given configuration.