SyncStatus

Constructors

new SyncStatus(options)

new SyncStatus(options): SyncStatus

Parameters

Parameter	Type
options	SyncStatusOptions

Returns

SyncStatus

Source

packages/common/lib/db/crud/SyncStatus.d.ts:13

Properties

Property	Modifier	Type
options	protected	SyncStatusOptions

Accessors

connected

get connected(): boolean

true if currently connected.

Returns

boolean

Source

packages/common/lib/db/crud/SyncStatus.d.ts:17

---

dataFlowStatus

get dataFlowStatus(): Partial< object >

Upload/download status

Returns

Partial< object >

Member	Type
downloading	boolean
uploading	boolean

Source

packages/common/lib/db/crud/SyncStatus.d.ts:31

---

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

Source

packages/common/lib/db/crud/SyncStatus.d.ts:27

---

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

Source

packages/common/lib/db/crud/SyncStatus.d.ts:22

Methods

getMessage()

getMessage(): string

Returns

string

Source

packages/common/lib/db/crud/SyncStatus.d.ts:36

---

isEqual()

isEqual(status): boolean

Parameters

Parameter	Type
status	SyncStatus

Returns

boolean

Source

packages/common/lib/db/crud/SyncStatus.d.ts:35

---

toJSON()

toJSON(): SyncStatusOptions

Returns

SyncStatusOptions

Source

packages/common/lib/db/crud/SyncStatus.d.ts:37