SyncStatus
Constructors
new SyncStatus()
new SyncStatus(options): SyncStatus
Parameters
| Parameter | Type |
|---|---|
options | SyncStatusOptions |
Returns
Accessors
connected
get connected(): boolean
true if currently connected.
Returns
boolean
dataFlowStatus
get dataFlowStatus(): Partial<{
downloading: boolean;
uploading: boolean;
}>
Upload/download status
Returns
Partial<{
downloading: boolean;
uploading: boolean;
}>
| Member | Type |
|---|---|
downloading | boolean |
uploading | boolean |
hasSynced
get hasSynced(): undefined | boolean
Indicates whether there has been at least one full sync, if any. Is undefined when unknown, for example when state is still being loaded from the database.
Returns
undefined | boolean
lastSyncedAt
get lastSyncedAt(): undefined | Date
Time that a last sync has fully completed, if any. Currently this is reset to null after a restart.
Returns
undefined | Date
Methods
getMessage()
getMessage(): string
Returns
string
isEqual()
isEqual(status): boolean
Parameters
| Parameter | Type |
|---|---|
status | SyncStatus |
Returns
boolean
toJSON()
toJSON(): SyncStatusOptions