Class LambdaResponse

Helper class useful for cases when:

  • response is not available in traditional sense (eg. lambda environment, fiddle, tests)
  • we need to run code that is dependant on having an editable response (cache revalidation)

Hierarchy

  • LambdaResponse

Implements

Constructors

constructor

Properties

body? chunks encodedChunks headers isDirectStream isDownstreamInit isEnded isHeadersStreamed isStreamableCallback isStreaming originalStream statusCode statusMessage?

Methods

clear clearHeaders end getData getHeader getHeaders initDownstream isCachable isStreamable removeHeader sendResponse setDecoder setDirectStream setEncoder setHeader setIsStreamable setOnEnd setOnHeaders setOnStream stream waitForFlush write fromAwsResponseStream fromNodeResponse

Constructors

constructor

  • Parameters

    • Optional responseStream: Writable
    • isDirectStream: boolean = false
    • originalStream: undefined | Writable = undefined

    Returns LambdaResponse

Properties

Optional body

body?: string | Buffer

The response body as a string or a Buffer

chunks

chunks: any[] = []

encodedChunks

encodedChunks: any[] = []

headers

headers: ResponseHeaders

isDirectStream

isDirectStream: boolean = false

isDownstreamInit

isDownstreamInit: boolean = false

isEnded

isEnded: boolean = false

isHeadersStreamed

isHeadersStreamed: boolean = false

isStreamableCallback

isStreamableCallback: (() => boolean) = ...

Type declaration

    • (): boolean

    • Returns boolean

isStreaming

isStreaming: boolean = false

originalStream

originalStream: undefined | Writable = undefined

statusCode

statusCode: number

The HTTP status code

Optional statusMessage

statusMessage?: string

The HTTP status message

Methods

clear

  • Returns void

clearHeaders

  • Returns void

end

  • Returns Promise<void>

getData

  • Returns {
        body: undefined | string | Buffer;
        headers: ResponseHeaders;
        statusCode: number;
        statusMessage: undefined | string;
    }

    • body: undefined | string | Buffer
    • headers: ResponseHeaders
    • statusCode: number
    • statusMessage: undefined | string

getHeader

  • 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

initDownstream

  • Returns void

isCachable

  • Returns boolean

isStreamable

  • Returns boolean

removeHeader

  • Removes a header

    Parameters

    • name: string

      The header to remove

    Returns void

sendResponse

  • Parameters

    • data: string

    Returns void

setDecoder

  • Parameters

    • value: Writable

    Returns void

setDirectStream

  • Parameters

    • value: boolean

    Returns void

setEncoder

  • Parameters

    • value: Writable

    Returns void

setHeader

  • Sets a header

    Parameters

    • name: string

      The name of the header to set

    • value: unknown

      The value to set

    Returns void

setIsStreamable

  • Parameters

    • callback: boolean | (() => boolean)

    Returns undefined | (() => boolean)

setOnEnd

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

setOnHeaders

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

setOnStream

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

stream

  • Returns void

waitForFlush

  • Returns Promise<boolean | void>

write

  • Parameters

    • chunk: string | Buffer

    Returns Promise<void>

Static fromAwsResponseStream

Static fromNodeResponse

Settings

Member Visibility

Theme

Generated using TypeDoc