Function testWebSocket

testWebSocket<
    const HostContext,
    const ThisWebSocket extends
        Readonly<WebSocketImplementation<WebSocketDefinition, HostContext>>,
    WebSocketClass extends CommonWebSocket,
>(
    webSocket: ThisWebSocket,
    createHostContext: CreateHostContext<HostContext>,
    params: WebSocketConnectParamObject<
        NoInfer<ThisWebSocket>["definition"],
        WebSocketClass,
    >,
): Promise<ClientWebSocket<ThisWebSocket["definition"], WebSocketClass>>
Test your WebSocket implementation with a real connection pipeline. Make sure to close your WebSocket after each test. Use withWebSocketTest to automatically close the WebSocket after a test.
Type Parameters
- const HostContext
- const ThisWebSocket extends Readonly<WebSocketImplementation<WebSocketDefinition, HostContext>>
- WebSocketClass extends CommonWebSocket
Parameters
- webSocket: ThisWebSocket
- createHostContext: CreateHostContext<HostContext>
- params: WebSocketConnectParamObject<
  NoInfer<ThisWebSocket>["definition"],
  WebSocketClass,
  >
Returns Promise<ClientWebSocket<ThisWebSocket["definition"], WebSocketClass>>
Package
@rest-vir/host
- Defined in packages/host/src/server/testing/test-web-socket.ts:23