Interface DispatchHandlers

interface DispatchHandlers {
    onBodySent(chunkSize: number, totalBytesSent: number): void;
    onComplete(trailers: null | string[]): void;
    onConnect(abort: (err?: Error) => void): void;
    onData(chunk: Buffer): boolean;
    onError(err: Error): void;
    onHeaders(
        statusCode: number,
        headers: Buffer[],
        resume: () => void,
        statusText: string,
    ): boolean;
    onResponseStarted(): void;
    onUpgrade(
        statusCode: number,
        headers: null | string[] | Buffer[],
        socket: Duplex,
    ): void;
}

Methods

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

Methods

OptionalonBodySent

  • onBodySent(chunkSize: number, totalBytesSent: number): void

    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

OptionalonComplete

  • onComplete(trailers: null | string[]): void

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

    Parameters

    • trailers: null | string[]

    Returns void

OptionalonConnect

  • onConnect(abort: (err?: Error) => void): void

    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: (err?: Error) => void

    Returns void

OptionalonData

  • onData(chunk: Buffer): boolean

    Invoked when response payload data is received.

    Parameters

    • chunk: Buffer

    Returns boolean

OptionalonError

  • onError(err: Error): void

    Invoked when an error has occurred.

    Parameters

    Returns void

OptionalonHeaders

  • onHeaders(
        statusCode: number,
        headers: Buffer[],
        resume: () => void,
        statusText: string,
    ): boolean

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

    Parameters

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

    Returns boolean

OptionalonResponseStarted

  • onResponseStarted(): void

    Invoked when response is received, before headers have been read. *

    Returns void

OptionalonUpgrade

  • onUpgrade(
        statusCode: number,
        headers: null | string[] | Buffer[],
        socket: Duplex,
    ): void

    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

On This Page

Methods