Class StreamedResponse<A>

A response that streams data from a readable stream.

Type Parameters

A

Hierarchy (View Summary)

Response<A>
- StreamedResponse

Index

Constructors

Properties

headers statusCode

Methods

send setCookie writeHead

Constructors

constructor

new StreamedResponse<A>(
    stream: ReadableStream,
    statusCode?: number,
    headers?: HeadersInit,
): StreamedResponse<A>
Construct a StreamedResponse.
Type Parameters
- A
Parameters
- stream: ReadableStream
  The readable stream to send in the response body.
- OptionalstatusCode: number = 200
  The HTTP response status code to send.
- Optionalheaders: HeadersInit
  The HTTP response headers to send.
Returns StreamedResponse<A>
Overrides Response.constructor
- Defined in src/response/StreamedResponse.ts:18

Properties

`Protected` `Readonly`headers

headers: Headers

The HTTP response headers to send.

`Readonly`statusCode

statusCode: number

The HTTP response status code to send.

Methods

`Protected`send

send(res: ServerResponse, req?: Request<A>): Promise<void>
Called once by the server to send the response.
Parameters
- res: ServerResponse
- Optionalreq: Request<A>
Returns Promise<void>
Overrides Response.send
- Defined in src/response/StreamedResponse.ts:25

setCookie

setCookie(cookie: Cookie): void
Set a response cookie.
Parameters
- cookie: Cookie
  The cookie to set.
Returns void
Inherited from Response.setCookie
- Defined in src/response/Response.ts:33

`Protected`writeHead

writeHead(res: ServerResponse, req?: Request<A>): void
Set and send the HTTP response status code and headers. No more headers can be sent after this.
Parameters
- res: ServerResponse
- Optionalreq: Request<A>
Returns void
Final
Inherited from Response.writeHead
- Defined in src/response/Response.ts:73