Skip to content
kit

RequestOptions

Type Alias: RequestOptions<TSchema>

Section titled “Type Alias: RequestOptions<TSchema>”

RequestOptions<TSchema> = object

Defined in: packages/fetch-kit/src/types.ts:206

Per-request options. Merge into the client’s defaults.

Type Parameters

Section titled “Type Parameters”

TSchema

Section titled “TSchema”

TSchema = unknown

Properties

Section titled “Properties”

cache?

Section titled “cache?”

optional cache?: CacheOption

Defined in: packages/fetch-kit/src/types.ts:220

Per-request cache override. See CacheOption.

dedupe?

Section titled “dedupe?”

optional dedupe?: boolean

Defined in: packages/fetch-kit/src/types.ts:222

Per-request dedupe override. Defaults to the client setting.

headers?

Section titled “headers?”

optional headers?: Record<string, string>

Defined in: packages/fetch-kit/src/types.ts:212

Additional headers merged into the request.

query?

Section titled “query?”

optional query?: Record<string, string | number | boolean | undefined>

Defined in: packages/fetch-kit/src/types.ts:214

Query parameters appended to the URL.

retry?

Section titled “retry?”

optional retry?: RetryConfig

Defined in: packages/fetch-kit/src/types.ts:210

Override retry config for this request.

schema?

Section titled “schema?”

optional schema?: Schema<TSchema>

Defined in: packages/fetch-kit/src/types.ts:216

Optional schema to validate the response body.

signal?

Section titled “signal?”

optional signal?: AbortSignal

Defined in: packages/fetch-kit/src/types.ts:218

External AbortSignal to cancel the request.

timeout?

Section titled “timeout?”

optional timeout?: number

Defined in: packages/fetch-kit/src/types.ts:208

Override the timeout for this request.