Class JsonResponse<T, A>

An HTTP response with a plain text body.

Type Parameters

T
A

Hierarchy (View Summary)

TextResponse<A>
- JsonResponse

Index

Constructors

Properties

buffer headers statusCode

Methods

allHeaders send setCookie writeHead serialise

Constructors

constructor

new JsonResponse<T, A>(
    json: T,
    statusCode?: number,
    headers?: HeadersInit,
): JsonResponse<T, A>
Construct a new JsonResponse.
Type Parameters
- T
- A
Parameters
- json: T
  The JSON data 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 JsonResponse<T, A>
Overrides TextResponse.constructor
- Defined in src/response/JsonResponse.ts:10

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
Inherited from TextResponse.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 TextResponse.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 TextResponse.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 TextResponse.writeHead
- Defined in src/response/Response.ts:73

`Protected` `Static`serialise

serialise(value: any): string
Parameters
- value: any
Returns string
- Defined in src/response/JsonResponse.ts:15