Type Alias BaseWebSocketImplementationParams<ThisWebSocket, WithMessage, Context>

BaseWebSocketImplementationParams: {
    context: Context;
    protocols: WebSocketConnectProtocolType<ThisWebSocket>;
    requestHeaders: Readonly<Record<string, string | string[] | undefined>>;
    searchParams: NonNullable<RouteSearchParamsType<ThisWebSocket>>;
    webSocketDefinition: ThisWebSocket extends WebSocketDefinition
        ? Readonly<ThisWebSocket>
        : Readonly<WebSocketDefinition>;
} & (
    IsEqual<WithMessage, true> extends true
        ? { message: WebSocketClientMessageType<ThisWebSocket> }
        : unknown
)

The portion of a WebSocket implementation's parameters that is independent of the runtime environment. Both host (server) implementations and client (mock) implementations include these fields; each side adds its own environment-specific extras on top via WebSocketListenerImplementationsBase.

Type Parameters

ThisWebSocket extends Readonly<WebSocketDefinition> | NoParam = NoParam
WithMessage extends boolean = boolean
Context = unknown

Package

@rest-vir/api

Type Alias BaseWebSocketImplementationParams<ThisWebSocket, WithMessage, Context>

Type Parameters

Package

Settings