Class HTTPErrorResponseFactory

Response factory that renders the given HTTPError in the specified output format.

Hierarchy

ErrorResponseFactory
- HTTPErrorResponseFactory

Index

Constructors

Properties

error targetMode targetStatus thrownError

Methods

buildHTML buildJSON getSuggestion mode status write

Constructors

constructor

new HTTPErrorResponseFactory(error: HTTPError, output?: "json" | "html" | "auto"): HTTPErrorResponseFactory
Parameters
- error: HTTPError
- output: "json" | "html" | "auto" = 'auto'
Returns HTTPErrorResponseFactory
Overrides ErrorResponseFactory.constructor
- Defined in src/http/response/HTTPErrorResponseFactory.ts:19

Properties

`Readonly` error

error: HTTPError

`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
Inherited from ErrorResponseFactory.buildHTML
- Defined in src/http/response/ErrorResponseFactory.ts:66

`Protected` buildJSON

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

`Protected` getSuggestion

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

mode

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

status

status(status: HTTPStatus): HTTPErrorResponseFactory
Set the target status of this factory.
Parameters
- status: HTTPStatus
Returns HTTPErrorResponseFactory
Inherited from ErrorResponseFactory.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>
Inherited from ErrorResponseFactory.write
- Defined in src/http/response/ErrorResponseFactory.ts:44