Class TextResponse<A>

An HTTP response with a plain text body.

Type Parameters

A

Hierarchy (View Summary)

BufferResponse<A>
- TextResponse
  - JsonResponse

Index

Constructors

Properties

buffer headers statusCode

Methods

allHeaders send setCookie writeHead

Constructors

constructor

new TextResponse<A>(
    text: string,
    statusCode?: number,
    headers?: HeadersInit,
): TextResponse<A>
Construct a new TextResponse.
Type Parameters
- A
Parameters
- text: string
  The plain text body of the response.
- OptionalstatusCode: number = 200
  The HTTP response status code to send.
- Optionalheaders: HeadersInit
  The HTTP response headers to send.
Returns TextResponse<A>
Overrides BufferResponse.constructor
- Defined in src/response/TextResponse.ts:18

Properties

`Protected` `Readonly`buffer

buffer: Uint8Array

Fetch the buffer to send in the response body.

`Protected` `Readonly`headers

headers: Headers

The HTTP response headers to send.

`Readonly`statusCode

statusCode: number

The HTTP response status code to send.

Methods

allHeaders

allHeaders(res: ServerResponse, req?: Request<A>): Headers
Parameters
- res: ServerResponse
- Optionalreq: Request<A>
Returns Headers
Overrides BufferResponse.allHeaders
- Defined in src/response/TextResponse.ts:23

`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>
Inherited from BufferResponse.send
- Defined in src/response/BufferResponse.ts:27

setCookie

setCookie(cookie: Cookie): void
Set a response cookie.
Parameters
- cookie: Cookie
  The cookie to set.
Returns void
Inherited from BufferResponse.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 BufferResponse.writeHead
- Defined in src/response/Response.ts:73