clean-jsdoc-theme TypeDoc APIv0.0.0

RequestConfig

interface RequestConfig { headers?: Record<string, string>; params?: Record<string, string | number | boolean>; responseType?: 'text' | 'json' | 'blob' | 'arraybuffer'; retries?: number; retryDelay?: number; signal?: AbortSignal; timeout?: number; withCredentials?: boolean; }

Source: HttpClient.ts:23

Request configuration options


Properties

headers: Record<string, string>

Request headers

params: Record<string, string | number | boolean>

Query parameters

responseType: 'text' | 'json' | 'blob' | 'arraybuffer'

Response type expectation

Default: ```ts 'json' ```

retries: number

Number of retry attempts on failure

Default: ```ts 0 ```

retryDelay: number

Delay between retries in milliseconds

Default: ```ts 1000 ```

signal: AbortSignal

Abort signal for cancellation

timeout: number

Request timeout in milliseconds

Default: ```ts 30000 ```

withCredentials: boolean

Whether to include credentials

Default: ```ts false ```