Class DehydratedStateResponseFactory

Response factor that sends a Rehydratable class' data as JSON.

Hierarchy

ResponseFactory
- DehydratedStateResponseFactory

Index

Constructors

Properties

rehydratable targetStatus

Methods

Constructors

constructor

new DehydratedStateResponseFactory(rehydratable: Rehydratable): DehydratedStateResponseFactory
Parameters
- rehydratable: Rehydratable
Returns DehydratedStateResponseFactory
Overrides ResponseFactory.constructor
- Defined in src/http/response/DehydratedStateResponseFactory.ts:17

Properties

`Readonly` rehydratable

rehydratable: Rehydratable

`Protected` targetStatus

targetStatus: HTTPStatus = HTTPStatus.OK

The status that should be set on the response.

Methods

status

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