Class RouteResponseFactory

Response factory that sends an HTTP redirect to the given destination.

Hierarchy

ResponseFactory
- RouteResponseFactory

Index

Constructors

Properties

nameOrPath targetStatus

Methods

Constructors

constructor

new RouteResponseFactory(nameOrPath: string): RouteResponseFactory
Parameters
- nameOrPath: string
  
  The alias or path of the route to redirect to.
Returns RouteResponseFactory
Overrides ResponseFactory.constructor
- Defined in src/http/response/RouteResponseFactory.ts:20

Properties

`Readonly` nameOrPath

nameOrPath: string

The alias or path of the route to redirect to.

`Protected` targetStatus

targetStatus: HTTPStatus = HTTPStatus.MOVED_TEMPORARILY

The status that should be set on the response.

Methods

status

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