Skip to main content
zerotal

Documentation


Documentation / zerotal / client / RequestOptions

Interface: RequestOptions

Defined in: packages/client/src/ApiClient.ts:74

Extended by

Properties

headers?

optional headers?: Record<string, string>

Defined in: packages/client/src/ApiClient.ts:76

Extra headers merged on top of the client's default headers.


init?

optional init?: Omit<RequestInit, "method" | "headers" | "body">

Defined in: packages/client/src/ApiClient.ts:78

Additional RequestInit fields (e.g. credentials, mode, cache).


signal?

optional signal?: AbortSignal

Defined in: packages/client/src/ApiClient.ts:80

Abort signal for cancellation (combined with any timeout).


timeout?

optional timeout?: number

Defined in: packages/client/src/ApiClient.ts:82

Per-request timeout in ms (overrides the client default; 0 disables).


retry?

optional retry?: number | false | RetryOptions

Defined in: packages/client/src/ApiClient.ts:84

Per-request retry policy (overrides the client default; false disables).


responseType?

optional responseType?: "json" | "arrayBuffer" | "blob" | "text" | "auto"

Defined in: packages/client/src/ApiClient.ts:86

How to read the response body. Default "auto" (JSON with text fallback).


meta?

optional meta?: (meta) => void

Defined in: packages/client/src/ApiClient.ts:88

Read response metadata (status, headers) without a global interceptor.

Parameters

meta

ResponseMeta

Returns

void