Type Alias WebSocketConnectParamObject<ThisWebSocket, WebSocketClass>

WebSocketConnectParamObject: SetNullishPropertiesAsOptional<
    {
        listeners: ConnectWebSocketListeners<ThisWebSocket, WebSocketClass>;
        pathParams: ExtractPathParams<
            ThisWebSocket extends { path: string }
                ? ThisWebSocket["path"]
                : NoParam,
        >;
        protocols: WebSocketConnectProtocolType<ThisWebSocket>;
        searchParams: RouteSearchParamsType<ThisWebSocket>;
        webSocketConstructor?: WebSocketConnectWebSocketConstructor<
            WebSocketClass,
        >;
    },
>

An client params object for calling an endpoint. Only the params that have required options to set are required, the rest are optional. Pass NoParam for a completely generic param object that all param objects should be assignable to, with all properties being optional.

Type Parameters

ThisWebSocket extends WebSocketDefinition | NoParam = NoParam
WebSocketClass extends CommonWebSocket | NoParam = NoParam

Package

@rest-vir/api

Type Alias WebSocketConnectParamObject<ThisWebSocket, WebSocketClass>

Type Parameters

Package

Settings