Documentation / zerotal / client / MutationOptions

Interface: MutationOptions<Q>

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

Extends

RequestOptions

Type Parameters

Q

Q

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.

Inherited from

RequestOptions.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).

Inherited from

RequestOptions.init

signal?

optional signal?: AbortSignal

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

Abort signal for cancellation (combined with any timeout).

Inherited from

RequestOptions.signal

timeout?

optional timeout?: number

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

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

Inherited from

RequestOptions.timeout

retry?

optional retry?: number | false | RetryOptions

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

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

Inherited from

RequestOptions.retry

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).

Inherited from

RequestOptions.responseType

meta?

optional meta?: (meta) => void

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

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

Parameters

Returns

void

Inherited from

RequestOptions.meta

params?

optional params?: Record<string, string | number>

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

URL path parameters for routes like /api/users/{id}/action.

query?

optional query?: Q

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

Query-string parameters.