Skip to main content

Interface: WebSocketFetchConfig

Defined in: packages/core/src/platform/websocket-fetch.ts:39

Properties​

baseFetch?​

optional baseFetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/core/src/platform/websocket-fetch.ts:49

Fetch for requests that do not go over WebSocket (default: globalThis.fetch)

Call Signature​

(input, init?): Promise<Response>

MDN Reference

Parameters​
input​

RequestInfo | URL

init?​

RequestInit

Returns​

Promise<Response>

Call Signature​

(input, init?): Promise<Response>

MDN Reference

Parameters​
input​

string | Request | URL

init?​

RequestInit

Returns​

Promise<Response>


connectionUrl​

connectionUrl: string

Defined in: packages/core/src/platform/websocket-fetch.ts:41

Used for a request whose own URL is not ws:// or wss://.


events?​

optional events?: Record<string, (data) => void>

Defined in: packages/core/src/platform/websocket-fetch.ts:46

Handlers keyed by a message's type, event or event_type field. A handler that throws is logged, not rethrown.


headers?​

optional headers?: Record<string, string>

Defined in: packages/core/src/platform/websocket-fetch.ts:56

Sent in the handshake where the platform supports it (Node with ws). Browsers and React Native cannot set handshake headers, so there they go into the URL as query parameters (lower-cased, - → _) — secrets included.


reconnect?​

optional reconnect?: ReconnectConfig

Defined in: packages/core/src/platform/websocket-fetch.ts:47