Interface RequestConfig

interface RequestConfig {
    body?: BodyInit;
    cache?: boolean | CacheConfig;
    credentials?: RequestCredentials;
    data?: unknown;
    dispatcher?: Dispatcher;
    duplex?: "half";
    errorInterceptors?: ErrorInterceptor[];
    headers?: HeadersInit;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    onAbort?: (() => void);
    onDownloadProgress?: ((loaded, total) => void);
    onError?: ((error) => void);
    onFinally?: (() => void);
    onSuccess?: ((data) => void);
    params?: Record<PropertyKey, any>;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    requestInterceptors?: RequestInterceptor[];
    responseInterceptors?: ResponseInterceptor<any, any>[];
    retry?: number;
    retryDelay?: number;
    signal?: AbortSignal;
    sse?: boolean | SSEConfig;
    timeout?: number;
    window?: null;
}

Hierarchy

  • RequestInit
    • RequestConfig

Properties

body? cache? credentials? data? dispatcher? duplex? errorInterceptors? headers? integrity? keepalive? method? mode? onAbort? onDownloadProgress? onError? onFinally? onSuccess? params? redirect? referrer? referrerPolicy? requestInterceptors? responseInterceptors? retry? retryDelay? signal? sse? timeout? window?

Properties

Optional body

body?: BodyInit

Optional cache

cache?: boolean | CacheConfig

Response cache configuration. true = default TTL (5000ms).

Optional credentials

credentials?: RequestCredentials

Optional data

data?: unknown

Optional dispatcher

dispatcher?: Dispatcher

Optional duplex

duplex?: "half"

Optional errorInterceptors

errorInterceptors?: ErrorInterceptor[]

Optional headers

headers?: HeadersInit

Optional integrity

integrity?: string

Optional keepalive

keepalive?: boolean

Optional method

method?: string

Optional mode

mode?: RequestMode

Optional onAbort

onAbort?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onDownloadProgress

onDownloadProgress?: ((loaded, total) => void)

Download progress callback. Receives (loadedBytes, totalBytes).

Type declaration

    • (loaded, total): void

    • Parameters

      • loaded: number
      • total: number

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: unknown

      Returns void

Optional onFinally

onFinally?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onSuccess

onSuccess?: ((data) => void)

Type declaration

    • (data): void

    • Parameters

      • data: unknown

      Returns void

Optional params

params?: Record<PropertyKey, any>

Optional redirect

redirect?: RequestRedirect

Optional referrer

referrer?: string

Optional referrerPolicy

referrerPolicy?: ReferrerPolicy

Optional requestInterceptors

requestInterceptors?: RequestInterceptor[]

Optional responseInterceptors

responseInterceptors?: ResponseInterceptor<any, any>[]

Optional retry

retry?: number

Max retry count on failure. 0 = no retry.

Optional retryDelay

retryDelay?: number

Delay between retries in milliseconds.

Optional signal

signal?: AbortSignal

Optional sse

sse?: boolean | SSEConfig

SSE configuration. Enables Server-Sent Events mode when provided.

Optional timeout

timeout?: number

Request timeout in milliseconds. 0 or undefined = no timeout.

Optional window

window?: null

Settings

Member Visibility

Theme

On This Page

bodycachecredentialsdatadispatcherduplexerrorInterceptorsheadersintegritykeepalivemethodmodeonAbortonDownloadProgressonErroronFinallyonSuccessparamsredirectreferrerreferrerPolicyrequestInterceptorsresponseInterceptorsretryretryDelaysignalssetimeoutwindow