Interface default

Represents an outgoing response.

Hierarchy

default

Implemented by

LambdaResponse

Index

Properties

body? getHeader getHeaders removeHeader setHeader statusCode? statusMessage?

Properties

`Optional` body

body?: string | Buffer

The response body as a string or a Buffer

getHeader

getHeader: ((name: string) => unknown)

Type declaration

- (name: string): unknown
- Gets the first value of a header
  
  Returns
  The value of the header
  Parameters
  - name: string
    
    The name of the header to return
  Returns unknown

getHeaders

getHeaders: (() => ResponseHeaders)

Type declaration

- (): ResponseHeaders
- Gets all headers as key/value pairs.
  
  Returns ResponseHeaders

removeHeader

removeHeader: ((name: string) => void)

Type declaration

- (name: string): void
- Removes a header
  Parameters
  - name: string
    
    The header to remove
  Returns void

setHeader

setHeader: ((name: string, value: unknown) => void)

Type declaration

- (name: string, value: unknown): void
- Sets a header
  Parameters
  - name: string
    
    The name of the header to set
  - value: unknown
    
    The value to set
  Returns void

`Optional` statusCode

statusCode?: number

The HTTP status code

`Optional` statusMessage

statusMessage?: string

The HTTP status message

Generated using TypeDoc