Function apiWs

apiWs<
    RequestCommandsT extends AnyCommands,
    ResponseCommandsT extends AnyCommands,
    QueryT extends AnyQuery,
>(
    api: WsApi<RequestCommandsT, ResponseCommandsT, QueryT>,
    req: OptionalIfPossiblyUndefined<"query", QueryT>,
    responseHandlers: Partial<
        WsApiResponseHandlers<RequestCommandsT, ResponseCommandsT, QueryT>,
    >,
    __namedParameters?: ApiWsOptions<RequestCommandsT, QueryT> & {
        context?: ApiRoutingContext;
    },
): Promise<ApiWs<RequestCommandsT, ResponseCommandsT, QueryT>>
Uses a WebSocket to access the specified API
Type Parameters
- RequestCommandsT extends AnyCommands
- ResponseCommandsT extends AnyCommands
- QueryT extends AnyQuery
Parameters
- api: WsApi<RequestCommandsT, ResponseCommandsT, QueryT>
- req: OptionalIfPossiblyUndefined<"query", QueryT>
- responseHandlers: Partial<WsApiResponseHandlers<RequestCommandsT, ResponseCommandsT, QueryT>>
- __namedParameters: ApiWsOptions<RequestCommandsT, QueryT> & { context?: ApiRoutingContext } = {}
Returns Promise<ApiWs<RequestCommandsT, ResponseCommandsT, QueryT>>