Interface RequestOptions

HTTP request options.

interface RequestOptions {
    headers?: Record<string, string>;
    maxRetries?: number;
    params?: Record<string, any>;
    retry?: boolean;
    timeout?: number;
}

Properties

headers? maxRetries? params? retry? timeout?

Properties

Optional headers

headers?: Record<string, string>

Request headers to merge with default headers.

Optional maxRetries

maxRetries?: number

Maximum number of retry attempts. Defaults to 3 attempts.

Optional params

params?: Record<string, any>

Query parameters to append to the URL.

Optional retry

retry?: boolean

Whether to retry failed requests. Defaults to true for GET requests.

Optional timeout

timeout?: number

Request timeout in milliseconds. Overrides the client's default timeout.

Settings

Member Visibility

Theme

On This Page

headersmaxRetriesparamsretrytimeout