Class HTTPErrorResponseFactory

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

Hierarchy

ErrorResponseFactory
- HTTPErrorResponseFactory

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HTTPErrorResponseFactory(error: HTTPError, output?: "html" | "json" | "auto"): HTTPErrorResponseFactory

Overrides ErrorResponseFactory.constructor
- Defined in src/http/response/HTTPErrorResponseFactory.ts:18
Parameters
- error: HTTPError
- output: "html" | "json" | "auto" = 'auto'
Returns HTTPErrorResponseFactory

Properties

Readonly error

error: HTTPError

Protected targetMode

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

Protected targetStatus

targetStatus: HTTPStatus = ...

The status that should be set on the response.

Readonly thrownError

thrownError: Error

Methods

Protected buildHTML

buildHTML(thrownError: Error): string

Inherited from ErrorResponseFactory.buildHTML
- Defined in src/http/response/ErrorResponseFactory.ts:66
Build the HTML display for the given error.

Parameters
- thrownError: Error
Returns string

string

Protected buildJSON

buildJSON(thrownError: Error): string

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

mode

mode(output: "html" | "json" | "auto"): ErrorResponseFactory

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

status

status(status: HTTPStatus): HTTPErrorResponseFactory

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

Parameters
- status: HTTPStatus
Returns HTTPErrorResponseFactory

write

write(request: Request): Promise<Request>

Inherited from ErrorResponseFactory.write
- Defined in src/http/response/ErrorResponseFactory.ts:44
Parameters
- request: Request
Returns Promise<Request>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.