Skip to content

js-bao-wss-client


js-bao-wss-client / DocumentMetadataChangedEvent

Interface: DocumentMetadataChangedEvent ​

Payload of the documentMetadataChanged event (client.on("documentMetadataChanged", ...)). Fired when the locally cached metadata for a document is created, updated, evicted, or deleted. metadata is the new entry (or null when removed), changedFields lists what changed, and source says whether the change came from a local edit, a server update, or local persistence.

Properties ​

action? ​

optional action?: "created" | "updated" | "evicted" | "deleted"


changedFields? ​

optional changedFields?: string[]


documentId ​

documentId: string


metadata ​

metadata: LocalMetadataEntry | null


source? ​

optional source?: "server" | "local" | "idb"

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30