Type alias WsApiRequestHandler<RequestCommandsT, ResponseCommandsT, CommandNameT, QueryT, ExtraArgsT>

WsApiRequestHandler<RequestCommandsT, ResponseCommandsT, CommandNameT, QueryT, ExtraArgsT>: ((args) => Promise<void>)

Type Parameters

RequestCommandsT extends AnyCommands
ResponseCommandsT extends AnyCommands
CommandNameT extends keyof RequestCommandsT & string
QueryT extends AnyQuery
ExtraArgsT extends Record<string, any> = Record<string, never>

Type declaration

- (args): Promise<void>
- Parameters
  - args: {
        connectionId: string;
        express: {
            next: NextFunction;
            req: Request;
            ws: WebSocket;
        };
        extras: ExtraArgsT;
        input: RequestCommandsT[CommandNameT]["valueType"];
        output: WsApiResponders<ResponseCommandsT>;
        query: QueryT;
    }
    - connectionId: string
    - express: {
          next: NextFunction;
          req: Request;
          ws: WebSocket;
      }
      next: NextFunction
      req: Request
      ws: WebSocket
    - extras: ExtraArgsT
    - input: RequestCommandsT[CommandNameT]["valueType"]
    - output: WsApiResponders<ResponseCommandsT>
    - query: QueryT
  Returns Promise<void>

Generated using TypeDoc