Skip to content

ClientOptions

Defined in: client/client.ts:50

optional autoConnect?: boolean

Defined in: client/client.ts:67

Connect immediately. Default true.


optional connect?: (url) => WebSocketLike

Defined in: client/client.ts:61

Opens the socket. Default: new WebSocket(url, 'shoehive.v1').

string

WebSocketLike


optional name?: string

Defined in: client/client.ts:54

Display name for a new guest.


optional reconnect?: false | { initialDelayMs?: number; maxDelayMs?: number; }

Defined in: client/client.ts:63

Reconnect with exponential backoff and jitter. Default on; false disables it.


optional requestTimeoutMs?: number

Defined in: client/client.ts:65

How long a request waits for its ack. Default 15 000 ms.


optional storage?: false | TokenStorage

Defined in: client/client.ts:59

Resume token storage. Default: localStorage in browsers, memory elsewhere. false disables it (every connection is a new guest).


url: string

Defined in: client/client.ts:52

Server URL, for example ws://localhost:3000/shoehive.