Class ViewResponseFactory

HTTP response factory that uses the ViewEngine service to render a view and send it as HTML.

Hierarchy

ResponseFactory
- ViewResponseFactory

Index

Constructors

Properties

data? targetStatus viewName

Methods

Constructors

constructor

new ViewResponseFactory(viewName: string, data?: {
[key: string]: any;
}): ViewResponseFactory
Parameters
- viewName: string
  
  The name of the view to render.
- Optional data: {
  [key: string]: any;
  }
  
  Optional data that should be passed to the view engine as params.
  - [key: string]: any
Returns ViewResponseFactory
Overrides ResponseFactory.constructor
- Defined in src/http/response/ViewResponseFactory.ts:30

Properties

`Optional` `Readonly` data

data?: {
[key: string]: any;
}

Optional data that should be passed to the view engine as params.

Type declaration

[key: string]: any

`Protected` targetStatus

targetStatus: HTTPStatus = HTTPStatus.OK

The status that should be set on the response.

`Readonly` viewName

viewName: string

The name of the view to render.

Methods

status

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