Function connectWebSocket

connectWebSocket<
    const WebSocketToConnect extends
        typeof NoParam
        | Readonly<GenericWebSocketDefinition>,
    WebSocketClass extends CommonWebSocket,
>(
    webSocketDefinition: WebSocketToConnect extends GenericWebSocketDefinition
        ? WebSocketToConnect<WebSocketToConnect>
        : Readonly<WebSocketDefinition>,
    ...params: CollapsedConnectWebSocketParams<
        WebSocketToConnect,
        true,
        WebSocketClass,
    >,
): Promise<ClientWebSocket<WebSocketToConnect, WebSocketClass>>
Creates and connects a new client WebSocket instance with type safety.
Type Parameters
- const WebSocketToConnect extends typeof NoParam | Readonly<GenericWebSocketDefinition>
- WebSocketClass extends CommonWebSocket
Parameters
- webSocketDefinition: WebSocketToConnect extends GenericWebSocketDefinition
  ? WebSocketToConnect<WebSocketToConnect>
  : Readonly<WebSocketDefinition>
- ...params: CollapsedConnectWebSocketParams<WebSocketToConnect, true, WebSocketClass>
Returns Promise<ClientWebSocket<WebSocketToConnect, WebSocketClass>>
Package
@rest-vir/define-service
- Defined in packages/define-service/src/frontend-connect/connect-web-socket.ts:216