Class ErrorResponseFactory

Response factory that renders an Error object to the client in a specified format.

Hierarchy

ResponseFactory
- ErrorResponseFactory
  - HTTPErrorResponseFactory

Index

Constructors

Properties

targetMode targetStatus thrownError

Methods

buildHTML buildJSON getSuggestion mode status write

Constructors

constructor

new ErrorResponseFactory(thrownError: Error, status: HTTPStatus, output?: "json" | "html" | "auto"): ErrorResponseFactory
Parameters
- thrownError: Error
- status: HTTPStatus
- output: "json" | "html" | "auto" = 'auto'
Returns ErrorResponseFactory
Overrides ResponseFactory.constructor
- Defined in src/http/response/ErrorResponseFactory.ts:29

Properties

`Protected` targetMode

targetMode: "json" | "html" | "auto" = 'auto'

`Protected` targetStatus

targetStatus: HTTPStatus = HTTPStatus.OK

The status that should be set on the response.

`Readonly` thrownError

thrownError: Error

Methods

`Protected` buildHTML

buildHTML(thrownError: Error): string
Build the HTML display for the given error.

Returns
string
Parameters
- thrownError: Error
Returns string
- Defined in src/http/response/ErrorResponseFactory.ts:66

`Protected` buildJSON

buildJSON(thrownError: Error): string
Parameters
- thrownError: Error
Returns string
- Defined in src/http/response/ErrorResponseFactory.ts:103

`Protected` getSuggestion

getSuggestion(): string
Returns string
- Defined in src/http/response/ErrorResponseFactory.ts:107

mode

mode(output: "json" | "html" | "auto"): ErrorResponseFactory
Parameters
- output: "json" | "html" | "auto"
Returns ErrorResponseFactory
- Defined in src/http/response/ErrorResponseFactory.ts:39

status

status(status: HTTPStatus): ErrorResponseFactory
Set the target status of this factory.
Parameters
- status: HTTPStatus
Returns ErrorResponseFactory
Inherited from ResponseFactory.status
- Defined in src/http/response/ResponseFactory.ts:22

write

write(request: Request): Promise<Request>
Called to write the response data to the HTTP response object.
Parameters
- request: Request
Returns Promise<Request>
Overrides ResponseFactory.write
- Defined in src/http/response/ErrorResponseFactory.ts:44