Function apiWs

Uses a WebSocket to access the specified API

apiWs<RequestCommandsT, ResponseCommandsT, QueryT>(api, req, responseHandlers, __namedParameters?): Promise<ApiWs<RequestCommandsT, ResponseCommandsT, QueryT>>
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>>