Class JSONResponseFactory

Response factory that writes the given object as JSON to the response.

Hierarchy

ResponseFactory
- JSONResponseFactory

Index

Constructors

Properties

targetStatus value

Methods

Constructors

constructor

new JSONResponseFactory(value: unknown): JSONResponseFactory
Parameters
- value: unknown
Returns JSONResponseFactory
Overrides ResponseFactory.constructor
- Defined in src/http/response/JSONResponseFactory.ts:16

Properties

`Protected` targetStatus

targetStatus: HTTPStatus = HTTPStatus.OK

The status that should be set on the response.

`Readonly` value

value: unknown

Methods

status

status(status: HTTPStatus): JSONResponseFactory
Set the target status of this factory.
Parameters
- status: HTTPStatus
Returns JSONResponseFactory
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/JSONResponseFactory.ts:22