Skip to content

js-bao-wss-client


js-bao-wss-client / LockStatus

Type Alias: LockStatus ​

LockStatus = { held: false; } | { acquiredAt: string | null; held: true; heldBy: string | null; holderKind: string | null; holderRunId: string | null; leaseExpiresAt: string | null; owner: string | null; }

Result of locks.status(): either { held: false } when the key is free (or its lease expired), or the current holder's identity and lease expiry.

Union Members ​

Type Literal ​

{ held: false; }


Type Literal ​

{ acquiredAt: string | null; held: true; heldBy: string | null; holderKind: string | null; holderRunId: string | null; leaseExpiresAt: string | null; owner: string | null; }

acquiredAt ​

acquiredAt: string | null

held ​

held: true

heldBy ​

heldBy: string | null

holderKind ​

holderKind: string | null

holderRunId ​

holderRunId: string | null

leaseExpiresAt ​

leaseExpiresAt: string | null

owner ​

owner: string | null

The owner the holder named, or null.

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