Class FileResponseFactory

HTTP response factory that sends a file referenced by a given UniversalPath.

Hierarchy

ResponseFactory
- FileResponseFactory

Index

Constructors

Properties

path targetStatus

Methods

Constructors

constructor

new FileResponseFactory(path: UniversalPath): FileResponseFactory
Parameters
- path: UniversalPath
  
  The file to be sent.
Returns FileResponseFactory
Overrides ResponseFactory.constructor
- Defined in src/http/response/FileResponseFactory.ts:18

Properties

`Readonly` path

path: UniversalPath

The file to be sent.

`Protected` targetStatus

targetStatus: HTTPStatus = HTTPStatus.OK

The status that should be set on the response.

Methods

status

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