Skip to content

js-bao-wss-client


js-bao-wss-client / AuthRefreshDeferredEvent

Interface: AuthRefreshDeferredEvent ​

Payload of the auth-refresh-deferred event (client.on("auth-refresh-deferred", ...)). Fired when a token refresh could not be attempted and was either rescheduled (status: "scheduled", with nextAttemptMs until the next try) or abandoned because the client is offline (status: "offline").

Properties ​

cause? ​

optional cause?: string

The operation that asked for the refresh, when known.


error? ​

optional error?: unknown

The underlying failure, when the deferral followed a failed attempt: the message when an Error was thrown, otherwise the thrown value as-is.


nextAttemptMs? ​

optional nextAttemptMs?: number

Milliseconds until the next scheduled attempt. Absent when no further attempt is promised (for example after going offline).


status ​

status: "offline" | "scheduled"

Why the refresh was deferred.

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