Interface DispatchOptions

interface DispatchOptions {
    blocking?: boolean;
    body?:
        | null
        | string
        | Uint8Array<ArrayBufferLike>
        | Buffer<ArrayBufferLike>
        | Readable
        | FormData;
    bodyTimeout?: null | number;
    expectContinue?: boolean;
    headers?:
        | null
        | string[]
        | Record<string, string | string[]>
        | IncomingHttpHeaders
        | Iterable<[string, undefined | string | string[]], any, any>;
    headersTimeout?: null | number;
    idempotent?: boolean;
    method: Dispatcher.HttpMethod;
    origin?: string | URL;
    path: string;
    query?: Record<string, any>;
    reset?: boolean;
    throwOnError?: boolean;
    upgrade?: null | string | boolean;
}

Hierarchy (View Summary)

Properties

blocking? body? bodyTimeout? expectContinue? headers? headersTimeout? idempotent? method origin? path query? reset? throwOnError? upgrade?

Properties

Optionalblocking

blocking?: boolean

Whether the response is expected to take a long time and would end up blocking the pipeline. When this is set to true further pipelining will be avoided on the same connection until headers have been received. Defaults to method !== 'HEAD'.

Optionalbody

body?:
    | null
    | string
    | Uint8Array<ArrayBufferLike>
    | Buffer<ArrayBufferLike>
    | Readable
    | FormData

Default: null

OptionalbodyTimeout

bodyTimeout?: null | number

The timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use 0 to disable it entirely. Defaults to 300 seconds.

OptionalexpectContinue

expectContinue?: boolean

For H2, it appends the expect: 100-continue header, and halts the request body until a 100-continue is received from the remote server

Optionalheaders

headers?:
    | null
    | string[]
    | Record<string, string | string[]>
    | IncomingHttpHeaders
    | Iterable<[string, undefined | string | string[]], any, any>

Default: null

OptionalheadersTimeout

headersTimeout?: null | number

The amount of time, in milliseconds, the parser will wait to receive the complete HTTP headers. Defaults to 300 seconds.

Optionalidempotent

idempotent?: boolean

Whether the requests can be safely retried or not. If false the request won't be sent until all preceding requests in the pipeline have completed. Default: true if method is HEAD or GET.

method

method: Dispatcher.HttpMethod

Optionalorigin

origin?: string | URL

path

path: string

Optionalquery

query?: Record<string, any>

Query string params to be embedded in the request URL. Default: null

Optionalreset

reset?: boolean

Whether the request should stablish a keep-alive or not. Default false

OptionalthrowOnError

throwOnError?: boolean

Whether Undici should throw an error upon receiving a 4xx or 5xx response from the server. Defaults to false

Optionalupgrade

upgrade?: null | string | boolean

Upgrade the request. Should be used to specify the kind of upgrade i.e. 'Websocket'. Default: method === 'CONNECT' || null.

Settings

Member Visibility

On This Page

Properties