Interface CommonRequestOptions

Options that are available to all requests.

interface CommonRequestOptions {
    abortController?: AbortController;
    aggregateTimeoutMs?: number;
    correlationId?: string;
    params?: Record<
        string,
        undefined
        | string
        | number
        | boolean
        | (string | number | boolean)[],
    >;
    retry?: CommercetoolsRetryConfig;
    timeoutMs?: number;
}

Hierarchy (View Summary)

Properties

abortController? aggregateTimeoutMs? correlationId? params? retry? timeoutMs?

Properties

OptionalabortController

abortController?: AbortController

An optional AbortController that can be used to abort the request

OptionalaggregateTimeoutMs

aggregateTimeoutMs?: number

The aggregate timeout in milliseconds (aggregate time spent across the original request and retries)

OptionalcorrelationId

correlationId?: string

A unique id used to track the source of a request.

Optionalparams

params?: Record<
    string,
    undefined
    | string
    | number
    | boolean
    | (string | number | boolean)[],
>

Query string parameters. For repeated param=value in the query string, define an array with values

Optionalretry

retry?: CommercetoolsRetryConfig

Retry configuration

OptionaltimeoutMs

timeoutMs?: number

The request timeout in milliseconds

Settings

Member Visibility

On This Page

Properties