Class Response

A class representing an HTTP response to a client.

Hierarchy

Response

Index

Constructors

constructor

new Response(request: Request, serverResponse?: ServerResponse): Response
Parameters
- request: Request
  
  The associated request object.
- Optional serverResponse: ServerResponse
  
  The native Node.js ServerResponse.
Returns Response
- Defined in src/http/lifecycle/Response.ts:64

Properties

body

body: string | Readable | Buffer | Uint8Array = ''

The body contents that should be written to the response.

`Private` headers

headers: {
[key: string]: string | string[];
} = {}

Mapping of headers that should be sent back to the client.

Type declaration

[key: string]: string | string[]

`Private` isBlockingWriteback

isBlockingWriteback: boolean = false

If this is true, then some module in the kernel has flagged the response as being interrupted and handled. Subsequent modules should NOT overwrite the response.

`Readonly` request

request: Request

The associated request object.

`Private` responseEnded

responseEnded: boolean = false

True if the response has been sent and closed.

`Readonly` sending$

sending$: BehaviorSubject<Response> = ...

Behavior subject fired right before the response content is written.

`Readonly` sent$

sent$: BehaviorSubject<Response> = ...

Behavior subject fired right after the response content is written.

`Private` sentHeaders

sentHeaders: boolean = false

True if the headers have been sent.

`Protected` `Optional` `Readonly` serverResponse

serverResponse?: ServerResponse

The native Node.js ServerResponse.

`Private` status

status: HTTPStatus = HTTPStatus.OK

The HTTP status code that should be sent to the client.

Accessors

cookies

get cookies(): HTTPCookieJar
Get the HTTPCookieJar for the client.

Returns HTTPCookieJar
- Defined in src/http/lifecycle/Response.ts:92

`Protected` logging

get logging(): Logging
Returns Logging
- Defined in src/http/lifecycle/Response.ts:72

Methods

appendHeader

appendHeader(name: string, value: string | string[]): Response
Add the given value as a header, appending it to an existing header if one exists.
Parameters
- name: string
- value: string | string[]
Returns Response
- Defined in src/http/lifecycle/Response.ts:146

blockingWriteback

blockingWriteback(set?: boolean): boolean
Get or set the flag for whether the writeback should be blocked.
Parameters
- Optional set: boolean
  
  if this is specified, the value will be set.
Returns boolean
- Defined in src/http/lifecycle/Response.ts:215

canSend

canSend(): boolean
Returns true if the response can still be sent. False if it has been sent or the connection has been destroyed.

Returns boolean
- Defined in src/http/lifecycle/Response.ts:287

end

end(): Response
Mark the response as ended and close the socket.

Returns Response
- Defined in src/http/lifecycle/Response.ts:294

getHeader

getHeader(name: string): undefined | string | string[]
Get the value of the response header, if it exists.
Parameters
- name: string
Returns undefined | string | string[]
- Defined in src/http/lifecycle/Response.ts:97

getStatus

getStatus(): HTTPStatus
Get the currently set response status.

Returns HTTPStatus
- Defined in src/http/lifecycle/Response.ts:77

hasBody

hasBody(): boolean
Returns true if a body has been set in the response.

Returns boolean
- Defined in src/http/lifecycle/Response.ts:207

hasSentHeaders

hasSentHeaders(): boolean
Returns true if the headers have been sent.

Returns boolean
- Defined in src/http/lifecycle/Response.ts:202

send

send(): Promise<void>
Send the response to the client, writing the headers and configured body.

Returns Promise<void>
- Defined in src/http/lifecycle/Response.ts:267

sendHeaders

sendHeaders(): Response
Write the headers to the client.

Returns Response
- Defined in src/http/lifecycle/Response.ts:174

setHeader

setHeader(name: string, value: string | string[]): Response
Set the value of the response header.
Parameters
- name: string
- value: string | string[]
Returns Response
- Defined in src/http/lifecycle/Response.ts:102

setHeaders

setHeaders(data: {
[name: string]: string | string[];
}): Response
Bulk set the specified headers in the response.
Parameters
- data: {
  [name: string]: string | string[];
  }
  - [name: string]: string | string[]
Returns Response
- Defined in src/http/lifecycle/Response.ts:130

setStatus

setStatus(status: HTTPStatus): Response
Set a new response status.
Parameters
- status: HTTPStatus
Returns Response
- Defined in src/http/lifecycle/Response.ts:82

unsetHeader

unsetHeader(name: string): Response
Remove a header from the response by name.
Parameters
- name: string
Returns Response
- Defined in src/http/lifecycle/Response.ts:116

write

write(data: string | Readable | Buffer | Uint8Array): Promise<void>
Write the headers and specified data to the client.
Parameters
- data: string | Readable | Buffer | Uint8Array
Returns Promise<void>
- Defined in src/http/lifecycle/Response.ts:227

Class Response

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

request: Request

Optional serverResponse: ServerResponse

Returns Response

Properties

body

Private headers

Type declaration

[key: string]: string | string[]

Private isBlockingWriteback

Readonly request

Private responseEnded

Readonly sending$

Readonly sent$

Private sentHeaders

Protected Optional Readonly serverResponse

Private status

Accessors

cookies

Returns HTTPCookieJar

Protected logging

Returns Logging

Methods

appendHeader

Parameters

name: string

value: string | string[]

Returns Response

blockingWriteback

Parameters

Optional set: boolean

Returns boolean

canSend

Returns boolean

end

Returns Response

getHeader

Parameters

name: string

Returns undefined | string | string[]

getStatus

Returns HTTPStatus

hasBody

Returns boolean

hasSentHeaders

Returns boolean

send

Returns Promise<void>

sendHeaders

Returns Response

setHeader

Parameters

name: string

value: string | string[]

Returns Response

setHeaders

Parameters

data: { [name: string]: string | string[]; }

[name: string]: string | string[]

Returns Response

setStatus

Parameters

status: HTTPStatus

Returns Response

unsetHeader

Parameters

name: string

Returns Response

write

Parameters

data: string | Readable | Buffer | Uint8Array

`Optional` serverResponse: ServerResponse

`Private` headers

`Private` isBlockingWriteback

`Readonly` request

`Private` responseEnded

`Readonly` sending$

`Readonly` sent$

`Private` sentHeaders

`Protected` `Optional` `Readonly` serverResponse

`Private` status

`Protected` logging

`Optional` set: boolean

data: {
[name: string]: string | string[];
}