Skip to main content

Interface: RequestOptions

Defined in: packages/client/src/core/types.ts:16

Per-request options accepted as the trailing parameter of every public method.

Stable​

Properties​

deadline?​

optional deadline?: number

Defined in: packages/client/src/core/types.ts:28

A hard wall-clock deadline (milliseconds) for the whole operation, including every retry attempt. Unlike timeout, this budget is not reset between attempts.

headers?​

optional headers?: Record<string, string>

Defined in: packages/client/src/core/types.ts:30

Extra headers merged over the client's configured headers for this request only.

requestId?​

optional requestId?: string

Defined in: packages/client/src/core/types.ts:32

Correlation id. Generated automatically if omitted; surfaced on FrappeError.request.requestId.

signal?​

optional signal?: AbortSignal

Defined in: packages/client/src/core/types.ts:18

Abort this specific request. Composed with the client's configured timeout.

timeout?​

optional timeout?: number

Defined in: packages/client/src/core/types.ts:23

Overrides the client's configured timeout for this request only. Applied per attempt — with the retry middleware, each retry gets the full budget again.