Interface RealtimeWebSocketTransportOptions<TFeature>

interface RealtimeWebSocketTransportOptions<TFeature> {
    cleanCloseCodes?: readonly number[];
    decodeEvent?: ((payload: unknown) => RealtimeFeatureEvent<TFeature>);
    encodeRequest?: ((url: URL, request: RealtimeSubscriptionRequest) => void);
    encodeSubscribeMessage?: ((request: RealtimeSubscriptionRequest) => unknown);
    protocols?: string | readonly string[];
    url: string;
    webSocketFactory?: RealtimeWebSocketFactory;
}

Type Parameters

  • TFeature = unknown

Properties

cleanCloseCodes? decodeEvent? encodeRequest? encodeSubscribeMessage? protocols? url webSocketFactory?

Properties

Optional ReadonlycleanCloseCodes

cleanCloseCodes?: readonly number[]

WebSocket close codes treated as a normal, non-reconnectable end of the stream rather than a transport-gap failure.

Default

[1000]

Optional ReadonlydecodeEvent

decodeEvent?: ((payload: unknown) => RealtimeFeatureEvent<TFeature>)

Optional ReadonlyencodeRequest

encodeRequest?: ((url: URL, request: RealtimeSubscriptionRequest) => void)

Optional ReadonlyencodeSubscribeMessage

encodeSubscribeMessage?: ((request: RealtimeSubscriptionRequest) => unknown)

Sent as a single JSON text frame immediately after the socket opens, for servers that expect an explicit subscribe message instead of (or in addition to) URL query parameters. The default transport never sends a subscribe frame on its own.

Optional Readonlyprotocols

protocols?: string | readonly string[]

Readonlyurl

url: string

Optional ReadonlywebSocketFactory

webSocketFactory?: RealtimeWebSocketFactory

Settings

Member Visibility

On This Page

Properties