js-bao-wss-client

---

js-bao-wss-client / SyncMetadataOptions

Interface: SyncMetadataOptions

Options for client.syncMetadata(). Controls whether the sync covers all of the user's document metadata or a single document (scope / documentId), whether errors are swallowed (background), whether the server response replaces the local index (authoritative), and which locally-known documents are retained (retainIds / shouldRetain).

Properties

authoritative?

optional authoritative?: boolean

---

background?

optional background?: boolean

---

documentId?

optional documentId?: string

---

forward?

optional forward?: boolean

---

includeRoot?

optional includeRoot?: boolean

---

pageSize?

optional pageSize?: number

---

payload?

optional payload?: any

---

payloadType?

optional payloadType?: "full" | "ids"

---

retainIds?

optional retainIds?: Iterable<string, any, any>

---

scope?

optional scope?: "all" | "single"

---

shouldRetain?

optional shouldRetain?: (documentId) => boolean

Parameters

documentId

string

Returns

boolean