Interface DispatchHandlers

Hierarchy

  • DispatchHandlers

Methods

onBodySent? onComplete? onConnect? onData? onError? onHeaders? onUpgrade?

Methods

Optional onBodySent

  • Invoked when a body chunk is sent to the server. May be invoked multiple times for chunked requests

    Parameters

    • chunkSize: number
    • totalBytesSent: number

    Returns void

Optional onComplete

  • Invoked when response payload and trailers have been received and the request has completed.

    Parameters

    • trailers: null | string[]

    Returns void

Optional onConnect

  • Invoked before request is dispatched on socket. May be invoked multiple times when a request is retried when the request at the head of the pipeline fails.

    Parameters

    • abort: (() => void)
        • (): void

        • Returns void

    Returns void

Optional onData

  • Invoked when response payload data is received.

    Parameters

    Returns boolean

Optional onError

  • Invoked when an error has occurred.

    Parameters

    • err: Error

    Returns void

Optional onHeaders

  • Invoked when statusCode and headers have been received. May be invoked multiple times due to 1xx informational headers.

    Parameters

    • statusCode: number
    • headers: null | string[] | Buffer[]
    • resume: (() => void)
        • (): void

        • Returns void

    Returns boolean

Optional onUpgrade

  • Invoked when request is upgraded either due to a Upgrade header or CONNECT method.

    Parameters

    • statusCode: number
    • headers: null | string[] | Buffer[]
    • socket: Duplex

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc