Skip to main content
Version: 1.11.1

Type Alias: WithRetryConfig

WithRetryConfig = { backoffMultiplier?: number; initialDelayMs?: number; logger?: { debug: (...args: unknown[]) => void; warn: (...args: unknown[]) => void; }; maxAttempts?: number; maxDelayMs?: number; respectRetryAfterHint?: boolean; }

Defined in: utils.ts:395

Configuration for the withRetry utility.

Properties

backoffMultiplier?

optional backoffMultiplier?: number

Defined in: utils.ts:401

Multiplier applied to delay after each retry


initialDelayMs?

optional initialDelayMs?: number

Defined in: utils.ts:399

Initial delay in milliseconds before the first retry


logger?

optional logger?: { debug: (...args: unknown[]) => void; warn: (...args: unknown[]) => void; }

Defined in: utils.ts:407

Optional logger for retry attempts

debug

debug: (...args: unknown[]) => void

Parameters
ParameterType
...argsunknown[]
Returns

void

warn

warn: (...args: unknown[]) => void

Parameters
ParameterType
...argsunknown[]
Returns

void


maxAttempts?

optional maxAttempts?: number

Defined in: utils.ts:397

Maximum number of retry attempts


maxDelayMs?

optional maxDelayMs?: number

Defined in: utils.ts:403

Maximum delay in milliseconds between retries


respectRetryAfterHint?

optional respectRetryAfterHint?: boolean

Defined in: utils.ts:405

Whether to respect the error's retryAfterMs hint