Class Response

The Response class provides a fluent API for constructing HTTP responses.

It wraps Node.js ServerResponse and streamlines the process of writing response body, setting headers, handling cookies, redirects, and streaming.

Example

response.status(200).json({ message: 'Hello World' })
response.redirect('/dashboard')
response.download('/path/to/file.pdf')

Hierarchy

default
- Response

Index

Constructors

constructor

new Response(
    request: IncomingMessage,
    response: ServerResponse,
    encryption: Encryption,
    config: ResponseConfig,
    router: Router,
    qs: Qs,
): Response
Creates a new Response instance
Parameters
- request: IncomingMessage
  Node.js IncomingMessage instance
- response: ServerResponse
  Node.js ServerResponse instance
- encryption: Encryption
  Encryption service for cookie handling
- config: ResponseConfig
  Response configuration settings
- router: Router
  Router instance for URL generation
- qs: Qs
  Query string parser
Returns Response
Overrides Macroable.constructor
- Defined in src/response.ts:167

Properties

lazyBody

lazyBody: Partial<
    {
        content: [any, boolean, string?];
        stream: [
            ResponseStream,
            (error: NodeJS.ErrnoException) => [string, number?]?,
        ];
        fileToStream: [
            string,
            boolean,
            (error: NodeJS.ErrnoException) => [string, number?]?,
        ];
    },
> = {}

Lazy body container that holds response content until ready to send. Contains different types of response data: content, stream, or fileToStream.

`Optional`ctx

ctx?: HttpContext

HTTP context reference (creates circular dependency with HttpContext)

request

request: IncomingMessage

Node.js IncomingMessage instance

response

response: ServerResponse

Node.js ServerResponse instance

Accessors

hasLazyBody

get hasLazyBody(): boolean
Indicates whether the response has any content (body, stream, or file) ready to be sent

Returns boolean
- Defined in src/response.ts:91

hasContent

get hasContent(): boolean
Indicates whether the response has non-stream content set

Returns boolean
- Defined in src/response.ts:98

hasStream

get hasStream(): boolean
Indicates whether the response body is set as a readable stream

Returns boolean
- Defined in src/response.ts:105

hasFileToStream

get hasFileToStream(): boolean
Indicates whether the response is configured to stream a file

Returns boolean
- Defined in src/response.ts:112

content

get content(): undefined | [any, boolean, string?]
The response content data

Returns undefined | [any, boolean, string?]
- Defined in src/response.ts:119

outgoingStream

get outgoingStream(): undefined | Readable
The readable stream instance configured for the response

Returns undefined | Readable
- Defined in src/response.ts:126

fileToStream

get fileToStream(): undefined | { path: string; generateEtag: boolean }
Configuration for file streaming including path and etag generation flag

Returns undefined | { path: string; generateEtag: boolean }
- Defined in src/response.ts:133

finished

get finished(): boolean
Indicates whether the response has been completely sent

Returns boolean
- Defined in src/response.ts:186

headersSent

get headersSent(): boolean
Indicates whether response headers have been sent to the client

Returns boolean
- Defined in src/response.ts:193

isPending

get isPending(): boolean
Indicates whether the response is still pending (headers and body can still be modified)

Returns boolean
- Defined in src/response.ts:200

Methods

onFinish

onFinish(callback: (err: null | Error, response: ServerResponse) => void): void
Registers a callback to be called when the response is finished

The callback is executed when the response has been completely sent. Uses the "on-finished" package internally.
Parameters
- callback: (err: null | Error, response: ServerResponse) => void
  Function to call when response is finished
Returns void
- Defined in src/response.ts:626

relayHeaders

relayHeaders(): void
Transfers all buffered headers to the underlying Node.js response object

Returns void
- Defined in src/response.ts:633

writeHead

writeHead(statusCode?: number): this
Writes the response status code and headers
Parameters
- OptionalstatusCode: number
  Optional status code to set
Returns this
The Response instance for chaining
- Defined in src/response.ts:650

getHeader

getHeader(key: string): undefined | OutgoingHttpHeader
Gets the value of a response header
Parameters
- key: string
  Header name
Returns undefined | OutgoingHttpHeader
The header value
- Defined in src/response.ts:661

getHeaders

getHeaders(): { [key: string]: undefined | OutgoingHttpHeader }
Gets all response headers as an object

Returns { [key: string]: undefined | OutgoingHttpHeader }
Object containing all headers
- Defined in src/response.ts:671

header(key: string, value: CastableHeader): this
Sets a response header (replaces existing value)
Parameters
- key: string
  Header name
- value: CastableHeader
  Header value (ignored if null/undefined)
Returns this
The Response instance for chaining
Example
```
response.header('Content-Type', 'application/json')
```
- Defined in src/response.ts:690

append

append(key: string, value: CastableHeader): this
Appends a value to an existing response header
Parameters
- key: string
  Header name
- value: CastableHeader
  Header value to append (ignored if null/undefined)
Returns this
The Response instance for chaining
Example
```
response.append('Set-Cookie', 'session=abc123')
```
- Defined in src/response.ts:711

safeHeader

safeHeader(key: string, value: CastableHeader): this
Sets a header only if it doesn't already exist
Parameters
- key: string
  Header name
- value: CastableHeader
  Header value
Returns this
The Response instance for chaining
- Defined in src/response.ts:746

removeHeader

removeHeader(key: string): this
Removes a response header
Parameters
- key: string
  Header name to remove
Returns this
The Response instance for chaining
- Defined in src/response.ts:759

getStatus

getStatus(): number
Gets the current response status code

Returns number
The HTTP status code
- Defined in src/response.ts:775

status

status(code: number): this
Sets the response status code
Parameters
- code: number
  HTTP status code
Returns this
The Response instance for chaining
- Defined in src/response.ts:785

safeStatus

safeStatus(code: number): this
Sets the status code only if not explicitly set already
Parameters
- code: number
  HTTP status code
Returns this
The Response instance for chaining
- Defined in src/response.ts:797

type

type(type: string, charset?: string): this
Sets the Content-Type header based on mime type lookup
Parameters
- type: string
  File extension or mime type
- Optionalcharset: string
  Optional character encoding
Returns this
The Response instance for chaining
Example
```
response.type('.json') // Content-Type: application/json
response.type('html', 'utf-8') // Content-Type: text/html; charset=utf-8
```
- Defined in src/response.ts:819

vary

vary(field: string | string[]): this
Sets the Vary HTTP header for cache control
Parameters
- field: string | string[]
  Header field name(s) to vary on
Returns this
The Response instance for chaining
- Defined in src/response.ts:832

setEtag

setEtag(body: any, weak?: boolean): this
Sets the ETag header by computing a hash from the response body
Parameters
- body: any
  The response body to hash
- weak: boolean = false
  Whether to generate a weak ETag
Returns this
The Response instance for chaining
- Defined in src/response.ts:844

setRequestId

setRequestId(): this
Sets the X-Request-Id header by copying from the incoming request

Returns this
The Response instance for chaining
- Defined in src/response.ts:854

fresh

fresh(): boolean
Checks if the response is fresh (client cache is valid)

Compares ETags and modified dates between request and response to determine if a 304 Not Modified response should be sent.

Returns boolean
True if client cache is fresh, false otherwise
Example
```
response.setEtag(content)
if (response.fresh()) {
  response.status(304).send(null)
} else {
  response.send(content)
}
```
- Defined in src/response.ts:880

getBody

getBody(): any
Gets the response body content

Returns any
The response body or null if not set or is a stream
- Defined in src/response.ts:901

send

send(body: any, generateEtag?: boolean): void
Sends the response body with optional ETag generation
Parameters
- body: any
  The response body
- generateEtag: boolean = ...
  Whether to generate ETag header (defaults to config)
Returns void
- Defined in src/response.ts:915

json

json(body: any, generateEtag?: boolean): void
Sends a JSON response (alias for send)
Parameters
- body: any
  The response body to serialize as JSON
- generateEtag: boolean = ...
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:925

jsonp

jsonp(body: any, callbackName?: string, generateEtag?: boolean): void
Sends a JSONP response with callback wrapping

Callback name resolution priority:
1. Explicit callbackName parameter
2. Query string parameter
3. Config value
4. Default "callback"
Parameters
- body: any
  The response body
- callbackName: string = ...
  JSONP callback function name
- generateEtag: boolean = ...
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:942

stream

stream(
body: Readable,
errorCallback?: (error: ErrnoException) => [string, number?],
): void
Pipes a readable stream to the response with graceful error handling
Parameters
- body: Readable
  The readable stream to pipe
- OptionalerrorCallback: (error: ErrnoException) => [string, number?]
  Optional custom error handler
Returns void
Example
```
// Auto error handling
response.stream(fs.createReadStream('file.txt'))

// Custom error handling
response.stream(stream, (error) => {
  return error.code === 'ENOENT' ? ['Not found', 404] : ['Error', 500]
})
```
- Defined in src/response.ts:967

download

download(
    filePath: string,
    generateEtag?: boolean,
    errorCallback?: (error: ErrnoException) => [string, number?],
): void
Downloads a file by streaming it with appropriate headers

Automatically sets:
- Content-Type from file extension
- Content-Length from file size
- Last-Modified from file stats
- ETag (if enabled)
Parameters
- filePath: string
  Path to the file to download
- generateEtag: boolean = ...
  Whether to generate ETag header
- OptionalerrorCallback: (error: ErrnoException) => [string, number?]
  Optional custom error handler
Returns void
Example
```
response.download('/path/to/file.pdf')
response.download('/images/photo.jpg', true, (err) => ['Custom error', 500])
```
- Defined in src/response.ts:997

attachment

attachment(
    filePath: string,
    name?: string,
    disposition?: string,
    generateEtag?: boolean,
    errorCallback?: (error: ErrnoException) => [string, number?],
): void
Forces file download by setting Content-Disposition header
Parameters
- filePath: string
  Path to the file to download
- Optionalname: string
  Optional filename for download (defaults to original filename)
- Optionaldisposition: string
  Content-Disposition type (defaults to 'attachment')
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
- OptionalerrorCallback: (error: ErrnoException) => [string, number?]
  Optional custom error handler
Returns void
- Defined in src/response.ts:1014

location

location(url: string): this
Sets the Location header for redirects
Parameters
- url: string
  The URL to redirect to
Returns this
The Response instance for chaining
Example
```
response.location('/dashboard')
```
- Defined in src/response.ts:1037

redirect

redirect(): Redirect
Returns a Redirect instance for fluent API usage

Use this overload when you want to use methods like .toRoute(), .back(), .withQs(), or other redirect builder methods.

Returns Redirect
Redirect instance for chaining redirect methods
Example
```
response.redirect().toRoute('users.show', { id: 1 })
response.redirect().back()
response.redirect().withQs().toPath('/dashboard')
```
- Defined in src/response.ts:1057
redirect(path: string, forwardQueryString?: boolean, statusCode?: number): void
Performs an immediate redirect to the specified path

This overload directly redirects the request with the provided parameters. Use this when you have a simple redirect without needing the fluent API.
Parameters
- path: string
  The path or URL to redirect to (use 'back' for referrer redirect)
- OptionalforwardQueryString: boolean
  Whether to forward current query string parameters
- OptionalstatusCode: number
  HTTP status code for redirect (defaults to 302 Found)
Returns void
Example
```
response.redirect('/dashboard')
response.redirect('/users', true, 301) // with query forwarding and 301 status
response.redirect('back') // redirect to referrer
```
- Defined in src/response.ts:1075

abort

abort(body: any, status?: number): never
Aborts the request with a custom response body and status code
Parameters
- body: any
  Response body for the aborted request
- Optionalstatus: number
  HTTP status code (defaults to 400)
Returns never
Throws
Always throws an HTTP exception
- Defined in src/response.ts:1105

abortIf

abortIf(
    condition: unknown,
    body: any,
    status?: number,
): asserts condition is undefined | null | false
Conditionally aborts the request if the condition is truthy
Parameters
- condition: unknown
  Condition to evaluate
- body: any
  Response body for the aborted request
- Optionalstatus: number
  HTTP status code (defaults to 400)
Returns asserts condition is undefined | null | false
- Defined in src/response.ts:1116

abortUnless

abortUnless<T>(
    condition: T,
    body: any,
    status?: number,
): asserts condition is Exclude<T, undefined | null | false>
Conditionally aborts the request if the condition is falsy
Type Parameters
- T
Parameters
- condition: T
  Condition to evaluate
- body: any
  Response body for the aborted request
- Optionalstatus: number
  HTTP status code (defaults to 400)
Returns asserts condition is Exclude<T, undefined | null | false>
- Defined in src/response.ts:1133

cookie(key: string, value: any, options?: Partial<CookieOptions>): this
Sets a signed cookie in the response
Parameters
- key: string
  Cookie name
- value: any
  Cookie value
- Optionaloptions: Partial<CookieOptions>
  Cookie options (overrides config defaults)
Returns this
The Response instance for chaining
- Defined in src/response.ts:1151

encryptedCookie

encryptedCookie(key: string, value: any, options?: Partial<CookieOptions>): this
Sets an encrypted cookie in the response
Parameters
- key: string
  Cookie name
- value: any
  Cookie value
- Optionaloptions: Partial<CookieOptions>
  Cookie options (overrides config defaults)
Returns this
The Response instance for chaining
- Defined in src/response.ts:1171

plainCookie

plainCookie(
    key: string,
    value: any,
    options?: Partial<CookieOptions & { encode: boolean }>,
): this
Sets a plain (unsigned/unencrypted) cookie in the response
Parameters
- key: string
  Cookie name
- value: any
  Cookie value
- Optionaloptions: Partial<CookieOptions & { encode: boolean }>
  Cookie options including encode flag
Returns this
The Response instance for chaining
- Defined in src/response.ts:1191

clearCookie

clearCookie(key: string, options?: Partial<CookieOptions>): this
Clears an existing cookie by setting it to expire
Parameters
- key: string
  Cookie name to clear
- Optionaloptions: Partial<CookieOptions>
  Cookie options (should match original cookie options)
Returns this
The Response instance for chaining
- Defined in src/response.ts:1214

finish

finish(): void
Finalizes and sends the response

Writes the buffered body (content, stream, or file) to the client. This method is idempotent - calling it multiple times has no effect.

Returns void
- Defined in src/response.ts:1230

continue

continue(): void
Sends a 100 Continue response

Returns void
- Defined in src/response.ts:1256

switchingProtocols

switchingProtocols(): void
Sends a 101 Switching Protocols response

Returns void
- Defined in src/response.ts:1264

ok

ok(body: any, generateEtag?: boolean): void
Sends a 200 OK response
Parameters
- body: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1275

created

created(body?: any, generateEtag?: boolean): void
Sends a 201 Created response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1286

accepted

accepted(body: any, generateEtag?: boolean): void
Sends a 202 Accepted response
Parameters
- body: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1297

nonAuthoritativeInformation

nonAuthoritativeInformation(body: any, generateEtag?: boolean): void
Sends a 203 Non-Authoritative Information response
Parameters
- body: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1308

noContent

noContent(): void
Sends a 204 No Content response

Returns void
- Defined in src/response.ts:1316

resetContent

resetContent(): void
Sends a 205 Reset Content response

Returns void
- Defined in src/response.ts:1324

partialContent

partialContent(body: any, generateEtag?: boolean): void
Sends a 206 Partial Content response
Parameters
- body: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1335

multipleChoices

multipleChoices(body?: any, generateEtag?: boolean): void
Sends a 300 Multiple Choices response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1346

movedPermanently

movedPermanently(body?: any, generateEtag?: boolean): void
Sends a 301 Moved Permanently response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1357

movedTemporarily

movedTemporarily(body?: any, generateEtag?: boolean): void
Sends a 302 Found (Moved Temporarily) response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1368

seeOther

seeOther(body?: any, generateEtag?: boolean): void
Sends a 303 See Other response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1379

notModified

notModified(body?: any, generateEtag?: boolean): void
Sends a 304 Not Modified response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1390

useProxy

useProxy(body?: any, generateEtag?: boolean): void
Sends a 305 Use Proxy response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1401

temporaryRedirect

temporaryRedirect(body?: any, generateEtag?: boolean): void
Sends a 307 Temporary Redirect response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1412

badRequest

badRequest(body?: any, generateEtag?: boolean): void
Sends a 400 Bad Request response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1423

unauthorized

unauthorized(body?: any, generateEtag?: boolean): void
Sends a 401 Unauthorized response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1434

paymentRequired

paymentRequired(body?: any, generateEtag?: boolean): void
Sends a 402 Payment Required response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1445

forbidden

forbidden(body?: any, generateEtag?: boolean): void
Sends a 403 Forbidden response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1456

notFound

notFound(body?: any, generateEtag?: boolean): void
Sends a 404 Not Found response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1467

methodNotAllowed

methodNotAllowed(body?: any, generateEtag?: boolean): void
Sends a 405 Method Not Allowed response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1478

notAcceptable

notAcceptable(body?: any, generateEtag?: boolean): void
Sends a 406 Not Acceptable response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1489

proxyAuthenticationRequired

proxyAuthenticationRequired(body?: any, generateEtag?: boolean): void
Sends a 407 Proxy Authentication Required response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1500

requestTimeout

requestTimeout(body?: any, generateEtag?: boolean): void
Sends a 408 Request Timeout response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1511

conflict

conflict(body?: any, generateEtag?: boolean): void
Sends a 409 Conflict response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1522

gone

gone(body?: any, generateEtag?: boolean): void
Sends a 410 Gone response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1533

lengthRequired

lengthRequired(body?: any, generateEtag?: boolean): void
Sends a 411 Length Required response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1544

preconditionFailed

preconditionFailed(body?: any, generateEtag?: boolean): void
Sends a 412 Precondition Failed response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1555

requestEntityTooLarge

requestEntityTooLarge(body?: any, generateEtag?: boolean): void
Sends a 413 Payload Too Large response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1566

requestUriTooLong

requestUriTooLong(body?: any, generateEtag?: boolean): void
Sends a 414 URI Too Long response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1577

unsupportedMediaType

unsupportedMediaType(body?: any, generateEtag?: boolean): void
Sends a 415 Unsupported Media Type response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1588

requestedRangeNotSatisfiable

requestedRangeNotSatisfiable(body?: any, generateEtag?: boolean): void
Sends a 416 Range Not Satisfiable response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1599

expectationFailed

expectationFailed(body?: any, generateEtag?: boolean): void
Sends a 417 Expectation Failed response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1610

unprocessableEntity

unprocessableEntity(body?: any, generateEtag?: boolean): void
Sends a 422 Unprocessable Entity response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1621

tooManyRequests

tooManyRequests(body?: any, generateEtag?: boolean): void
Sends a 429 Too Many Requests response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1632

internalServerError

internalServerError(body?: any, generateEtag?: boolean): void
Sends a 500 Internal Server Error response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1643

notImplemented

notImplemented(body?: any, generateEtag?: boolean): void
Sends a 501 Not Implemented response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1654

badGateway

badGateway(body?: any, generateEtag?: boolean): void
Sends a 502 Bad Gateway response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1665

serviceUnavailable

serviceUnavailable(body?: any, generateEtag?: boolean): void
Sends a 503 Service Unavailable response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1676

gatewayTimeout

gatewayTimeout(body?: any, generateEtag?: boolean): void
Sends a 504 Gateway Timeout response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1687

httpVersionNotSupported

httpVersionNotSupported(body?: any, generateEtag?: boolean): void
Sends a 505 HTTP Version Not Supported response
Parameters
- Optionalbody: any
  Response body
- OptionalgenerateEtag: boolean
  Whether to generate ETag header
Returns void
- Defined in src/response.ts:1698

Class Response

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Response

Properties

lazyBody

Optionalctx

request

response

Accessors

hasLazyBody

Returns boolean

hasContent

Returns boolean

hasStream

Returns boolean

hasFileToStream

Returns boolean

content

Returns undefined | [any, boolean, string?]

outgoingStream

Returns undefined | Readable

fileToStream

Returns undefined | { path: string; generateEtag: boolean }

finished

Returns boolean

headersSent

Returns boolean

isPending

Returns boolean

Methods

onFinish

Parameters

Returns void

relayHeaders

Returns void

writeHead

Parameters

Returns this

getHeader

Parameters

Returns undefined | OutgoingHttpHeader

getHeaders

Returns { [key: string]: undefined | OutgoingHttpHeader }

header

Parameters

Returns this

Example

append

Parameters

Returns this

Example

safeHeader

Parameters

Returns this

removeHeader

Parameters

Returns this

getStatus

Returns number

status

Parameters

Returns this

safeStatus

Parameters

Returns this

type

Parameters

Returns this

Example

vary

Parameters

`Optional`ctx