Type Alias CollapsedConnectWebSocketParams<WebSocketToConnect, AllowWebSocketMock, WebSocketClass>

CollapsedConnectWebSocketParams: WebSocketToConnect extends NoParam
    ? [Readonly<GenericConnectWebSocketParams<WebSocketClass>>?]
    : Readonly<
        ConnectWebSocketParams<
            Exclude<WebSocketToConnect, NoParam>,
            AllowWebSocketMock,
            WebSocketClass,
        >,
    > extends infer RealParams
        ? RequiredKeysOf<RealParams> extends never
            ? [RealParams?]
            : [RealParams]
        : []

Collapsed version of ConnectWebSocketParams for connectWebSocket that only requires an object parameter if the parameters object has any required keys.

Type Parameters

WebSocketToConnect extends
    | Readonly<
        SelectFrom<
            GenericWebSocketDefinition,
            {
                MessageFromClientType: true;
                MessageFromHostType: true;
                path: true;
                protocolsShape: true;
                ProtocolsType: true;
                searchParamsShape: true;
                SearchParamsType: true;
            },
        >,
    >
    | NoParam = NoParam
AllowWebSocketMock extends boolean = true
WebSocketClass extends CommonWebSocket = CommonWebSocket

Package

@rest-vir/define-service

Type Alias CollapsedConnectWebSocketParams<WebSocketToConnect, AllowWebSocketMock, WebSocketClass>

Type Parameters

Package

Settings