Skip to main content
Version: 1.14.0

Type Alias: ApiRetryConfig

ApiRetryConfig = { backoffMultiplier?: number; initialDelayMs?: number; maxDelayMs?: number; maxRetries?: number; respectRetryAfterHint?: boolean; }

Defined in: chain.ts:195

Configuration for retry behavior with exponential backoff.

Properties​

backoffMultiplier?​

optional backoffMultiplier?: number

Defined in: chain.ts:203

Multiplier applied to delay after each retry (exponential backoff). Set to 1 for fixed delays.


initialDelayMs?​

optional initialDelayMs?: number

Defined in: chain.ts:200

Initial delay in milliseconds before the first retry.


maxDelayMs?​

optional maxDelayMs?: number

Defined in: chain.ts:206

Maximum delay in milliseconds between retries (caps exponential growth).


maxRetries?​

optional maxRetries?: number

Defined in: chain.ts:197

Maximum number of retry attempts for transient errors.


respectRetryAfterHint?​

optional respectRetryAfterHint?: boolean

Defined in: chain.ts:209

Whether to respect the error's retryAfterMs hint when available. If true, uses max(calculated delay, error.retryAfterMs).