Skip to main content

Interface: RetryOptions

Defined in: shared/utils/retry.ts:47

Options controlling retry behavior for withRetry.

Properties​

delayMs?​

optional delayMs?: number | ((args: { attempt: number; error: unknown; }) => number)

Defined in: shared/utils/retry.ts:56

Delay between attempts in milliseconds.

Remarks​

Can be a constant or a function for exponential backoff / jitter.

Default Value​

300;

maxRetries?​

optional maxRetries?: number

Defined in: shared/utils/retry.ts:68

Maximum number of attempts (including the first attempt).

Default Value​

5;

onError?​

optional onError?: (error: unknown, attempt: number) => void

Defined in: shared/utils/retry.ts:77

Optional hook invoked after a failed attempt.

Parameters​

error​

unknown

attempt​

number

Returns​

void

Remarks​

Errors thrown by this callback are swallowed to avoid masking the original failure.

onFailedAttempt?​

optional onFailedAttempt?: (args: { attempt: number; delayMs: number; error: unknown; }) => void

Defined in: shared/utils/retry.ts:83

Optional hook invoked after a failed attempt and after the delay for the next attempt is computed.

Parameters​

args​
attempt​

number

delayMs​

number

error​

unknown

Returns​

void

operationName?​

optional operationName?: string

Defined in: shared/utils/retry.ts:90

Optional label for debugging/logging by callers.

shouldRetry?​

optional shouldRetry?: (error: unknown, attempt: number) => boolean

Defined in: shared/utils/retry.ts:98

Optional predicate to stop retrying for specific errors.

Parameters​

error​

unknown

attempt​

number

Returns​

boolean

Remarks​

Returning false stops retrying and rethrows the most recent error.

unrefDelay?​

optional unrefDelay?: boolean

Defined in: shared/utils/retry.ts:104

When true, uses an unref'd timer for the delay between retries so the process can exit naturally.