HeartbeatClientOptions
Defined in: src/web/heartbeat/client.ts:3
Properties
Section titled “Properties”crypto?
Section titled “crypto?”
optionalcrypto?:Pick<Crypto,"randomUUID">
Defined in: src/web/heartbeat/client.ts:57
Get random uuid implementation for status messages
Default
Section titled “Default”globalThis.cryptodisconnectTimeout?
Section titled “disconnectTimeout?”
optionaldisconnectTimeout?:number
Defined in: src/web/heartbeat/client.ts:38
Time in milliseconds of not receiving heartbeat responses after which the communication channel is disconnected
Default
Section titled “Default”5000establishTimeout?
Section titled “establishTimeout?”
optionalestablishTimeout?:number
Defined in: src/web/heartbeat/client.ts:16
Reasonable time in milliseconds in which the communication channel needs to be established
Default
Section titled “Default”10000onDisconnect
Section titled “onDisconnect”onDisconnect: () =>
void
Defined in: src/web/heartbeat/client.ts:42
Callback when no heartbeats have been received for disconnectTimeout milliseconds
Returns
Section titled “Returns”void
onEstablish
Section titled “onEstablish”onEstablish: (
origin,status) =>void
Defined in: src/web/heartbeat/client.ts:11
Callback when first heartbeat has been received
Parameters
Section titled “Parameters”origin
Section titled “origin”string
status
Section titled “status”"pending" | "ready"
Returns
Section titled “Returns”void
onEstablishTimeout
Section titled “onEstablishTimeout”onEstablishTimeout: () =>
void
Defined in: src/web/heartbeat/client.ts:20
Callback when no heartbeats have been received for establishTimeout milliseconds
Returns
Section titled “Returns”void
onPendingTimeout
Section titled “onPendingTimeout”onPendingTimeout: () =>
void
Defined in: src/web/heartbeat/client.ts:33
Callback when no heartbeats have been received for pendingTimeout milliseconds
Returns
Section titled “Returns”void
onStatusChange
Section titled “onStatusChange”onStatusChange: (
status) =>void
Defined in: src/web/heartbeat/client.ts:24
Callback when status response has changed
Parameters
Section titled “Parameters”status
Section titled “status”"pending" | "ready"
Returns
Section titled “Returns”void
pendingTimeout?
Section titled “pendingTimeout?”
optionalpendingTimeout?:number
Defined in: src/web/heartbeat/client.ts:29
Reasonable time in milliseconds in which the communication channel can be pending
Default
Section titled “Default”300000signerWindow
Section titled “signerWindow”signerWindow:
Window
Defined in: src/web/heartbeat/client.ts:7
Signer window to send and receive heartbeat messages from
statusPollingRate?
Section titled “statusPollingRate?”
optionalstatusPollingRate?:number
Defined in: src/web/heartbeat/client.ts:47
Status polling rate in ms
Default
Section titled “Default”300window?
Section titled “window?”
optionalwindow?:Window
Defined in: src/web/heartbeat/client.ts:52
Relying party window, used to listen for incoming message events
Default
Section titled “Default”globalThis.window