Class ListenerBuilder<DataType, ErrorType>

constructor

• new ListenerBuilder<DataType = unknown, ErrorType = unknown>(
      settings: string | ListenerBuilderSettings,
      ...handlers: Controller<DataType, ErrorType>[],
  ): ListenerBuilder<DataType, ErrorType>

  Type Parameters

  • DataType = unknown
  • ErrorType = unknown

  Parameters

  • settings: string | ListenerBuilderSettings

    The settings or the name of the event

  • ...handlers: Controller<DataType, ErrorType>[]

  Returns ListenerBuilder<DataType, ErrorType>

Optionaldescription

handlers

name

tags

handle

• handle(req: Request<DataType>, res: Response): void

  Parameters

  • req: Request<DataType>
  • res: Response

  Returns void

  Todo

  3rd param as onError callback

register

• register(socket: Socket, nsp: Namespace, io: Server): void

  Parameters

  • socket: Socket
  • nsp: Namespace
  • io: Server

  Returns void

removeErrorController

• removeErrorController(): ListenerBuilder<DataType, ErrorType>

  Returns ListenerBuilder<DataType, ErrorType>

  Description

  Stop listening to next(error) from Controller

setErrorController

• setErrorController(
      fn: ErrorController<ErrorType, DataType>,
  ): ListenerBuilder<DataType, ErrorType>

  Parameters

  • fn: ErrorController<ErrorType, DataType>

  Returns ListenerBuilder<DataType, ErrorType>

  Description

  Listen to next(error) from Controller

toJson

• toJson(): ListenerBuilderJson

  Returns ListenerBuilderJson