Skip to main content

Interface: RetryOptions

Defined in: packages/client/src/core/middleware.ts:48

Properties

attempts?

optional attempts?: number

Defined in: packages/client/src/core/middleware.ts:50

Default 2.


baseDelayMs?

optional baseDelayMs?: number

Defined in: packages/client/src/core/middleware.ts:52

Default 250ms, doubling each attempt.


jitter?

optional jitter?: boolean

Defined in: packages/client/src/core/middleware.ts:56

Randomize exponential backoff between zero and the calculated delay. Default false.


maxDelayMs?

optional maxDelayMs?: number

Defined in: packages/client/src/core/middleware.ts:54

Maximum exponential backoff. Default 30 seconds.


methods?

optional methods?: readonly string[]

Defined in: packages/client/src/core/middleware.ts:64

Which methods may be retried. Defaults to idempotent verbs only (GET/HEAD/PUT/DELETE). POST/PATCH are never retried by default because a lost response does not mean the mutation didn't apply on the server.


respectRetryAfter?

optional respectRetryAfter?: boolean

Defined in: packages/client/src/core/middleware.ts:58

Honor a valid server Retry-After header. Default true.


shouldRetry?

optional shouldRetry?: (res, error) => boolean

Defined in: packages/client/src/core/middleware.ts:66

Return true to retry this particular failure. Defaults to network / 429 / 5xx only.

Parameters

res

FrappeResponse | undefined

error

unknown

Returns

boolean