ClientOptions
Defined in: client/client.ts:50
Properties
Section titled “Properties”autoConnect?
Section titled “autoConnect?”
optionalautoConnect?:boolean
Defined in: client/client.ts:67
Connect immediately. Default true.
connect?
Section titled “connect?”
optionalconnect?: (url) =>WebSocketLike
Defined in: client/client.ts:61
Opens the socket. Default: new WebSocket(url, 'shoehive.v1').
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”
optionalname?:string
Defined in: client/client.ts:54
Display name for a new guest.
reconnect?
Section titled “reconnect?”
optionalreconnect?:false| {initialDelayMs?:number;maxDelayMs?:number; }
Defined in: client/client.ts:63
Reconnect with exponential backoff and jitter. Default on; false disables it.
requestTimeoutMs?
Section titled “requestTimeoutMs?”
optionalrequestTimeoutMs?:number
Defined in: client/client.ts:65
How long a request waits for its ack. Default 15 000 ms.
storage?
Section titled “storage?”
optionalstorage?: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.
