Interface Response

locals

end

• end(data?, encoding?): void

• Sends the HTTP response, optionally including data to write to the HTTP response body.

  Parameters

  • Optional data: string | Buffer
  • Optional encoding: string

  Returns void

getHeader

• getHeader(name): string

• Gets the Headers for the Response

  Parameters

  • name: string

  Returns string

json

• json(obj): void

• JSON serializes an object, writes it to the HTTP response body, and sends the HTTP response.

  Parameters

  • obj: any

  Returns void

redirect

• redirect(url): void

• Mark the response to redirect the client to the provided URL with the optional status code, defaulting to 302.

  Parameters

  • url: string

  Returns void
• redirect(status, url): void

• Parameters

  • status: number
  • url: string

  Returns void

setHeader

• setHeader(name, value): Response

• Sets a header on the HTTP response and returns the Response for chaining operations.

  Parameters

  • name: string
  • value: string

  Returns Response

status

• status(code): Response

• Sets the HTTP response status code and returns a Response for chaining operations.

  Parameters

  • code: number

  Returns Response

write

• write(data, encoding?): Response

• Writes a string to the HTTP response body and returns the Response for chaining operations.

  Parameters

  • data: string | Buffer
  • Optional encoding: string

  Returns Response