Function finalizeWebSocket

finalizeWebSocket<
    const WebSocketToConnect extends
        typeof NoParam
        | Readonly<WebSocketDefinition>,
    const WebSocketClass extends CommonWebSocket,
    const Location extends WebSocketLocation,
>(
    webSocketDefinition: WebSocketToConnect extends typeof NoParam
        ? WebSocketDefinition
        : WebSocketToConnect,
    webSocketInput: WebSocketClass,
    listeners:
        | undefined
        | Partial<
            {
                close: WebSocketListener<
                    "close",
                    typeof NoParam,
                    OnHost,
                    WebSocketClass,
                >;
                error: WebSocketListener<
                    "error",
                    typeof NoParam,
                    OnHost,
                    WebSocketClass,
                >;
                message: WebSocketListener<
                    "message",
                    typeof NoParam,
                    OnHost,
                    WebSocketClass,
                >;
                open: WebSocketListener<"open", typeof NoParam, OnHost, WebSocketClass>;
            },
        >,
    location: Location,
): Promise<
    OverwriteWebSocketMethods<WebSocketClass, Location, WebSocketToConnect>,
>
Overwrites WebSocket methods with the typed rest-vir replacements, attaches WebSocket listeners, and waits for the WebSocket to be opened.
Type Parameters
- const WebSocketToConnect extends typeof NoParam | Readonly<WebSocketDefinition>
- const WebSocketClass extends CommonWebSocket
- const Location extends WebSocketLocation
Parameters
- webSocketDefinition: WebSocketToConnect extends typeof NoParam
  ? WebSocketDefinition
  : WebSocketToConnect
- webSocketInput: WebSocketClass
  An already-constructed WebSocket instance.
- listeners:
      | undefined
      | Partial<
          {
              close: WebSocketListener<
                  "close",
                  typeof NoParam,
                  OnHost,
                  WebSocketClass,
              >;
              error: WebSocketListener<"error", typeof NoParam, OnHost, WebSocketClass>;
              message: WebSocketListener<
                  "message",
                  typeof NoParam,
                  OnHost,
                  WebSocketClass,
              >;
              open: WebSocketListener<"open", typeof NoParam, OnHost, WebSocketClass>;
          },
      >
- location: Location
Returns Promise<OverwriteWebSocketMethods<WebSocketClass, Location, WebSocketToConnect>>
Package
@rest-vir/define-service
- Defined in packages/define-service/src/web-socket/overwrite-web-socket-methods.ts:769

Function finalizeWebSocket

Type Parameters

Parameters

Returns Promise<OverwriteWebSocketMethods<WebSocketClass, Location, WebSocketToConnect>>

Package

Settings