Class ErrorHandlerStore

Error handler store. This store keeps the registered error handlers. Go through the Mesh API to register an error handler.

Hierarchy

ErrorHandlerStore

Index

Methods

Methods

registerErrorHandler

registerErrorHandler(status: number, handler: IMeshErrorHandler): void

- Defined in lib/meshHandlerStore.ts:172
Register an error handler for an error status. There can only be one handler per status.

Parameters
- status: number
  
  The status the handler should be registered for.
- handler: IMeshErrorHandler
  
  The handler that should be registered.
Returns void

unregisterErrorHandler

unregisterErrorHandler(status: number, handler?: IMeshErrorHandler): void

- Defined in lib/meshHandlerStore.ts:181
Unregister an error handler for a status.

Parameters
- status: number
  
  The status the handler should be unregistered from.
- Optional handler: IMeshErrorHandler
  
  The handler that should be unregistered.
Returns void

workErrorHandler

workErrorHandler(status: number, error: any, req: IMeshRequest, res: IMeshResponse): Promise<void>

- Defined in lib/meshHandlerStore.ts:194
Execute the error handler for a status.

Parameters
- status: number
  
  The status for which the handler should be executed.
- error: any
  
  An object describing the error.
- req: IMeshRequest
  
  The MeshRequest.
- res: IMeshResponse
  
  The MeshResponse
Returns Promise<void>

A promise, that will be fulfilled once the error handler has been executed and will be rejected if executing the error handler fails.

Generated using TypeDoc