Skip to content

js-bao-wss-client


js-bao-wss-client / LogoutOptions

Interface: LogoutOptions ​

Options for JsBaoClient.logout.

Properties ​

clearOfflineIdentity? ​

optional clearOfflineIdentity?: boolean

If false, preserves the in-memory offline identity after logout (default true).


redirectTo? ​

optional redirectTo?: string

URL to navigate to after logout completes (browser only).


revokeOffline? ​

optional revokeOffline?: boolean

If true, revokes the stored offline access grant.


waitForDisconnect? ​

optional waitForDisconnect?: boolean

If true, awaits WebSocket disconnection before resolving; set to false to avoid blocking UI (default false).


wipeLocal? ​

optional wipeLocal?: boolean

If true, deletes all locally cached document data and KV cache.

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