Interface: AsyncRetryerOptions\#

Defined in: async-retryer.ts:60

Type Parameters#

TFn#

TFn extends AnyAsyncFunction

Properties#

backoff?#

optional backoff: "linear" | "exponential" | "fixed";

Defined in: async-retryer.ts:68

The backoff strategy for retry delays:

• 'exponential': Wait time doubles with each attempt (1s, 2s, 4s, ...)

• 'linear': Wait time increases linearly (1s, 2s, 3s, ...)

• 'fixed': Same wait time for all attempts

Default#

'exponential'

baseWait?#

optional baseWait: number | (retryer) => number;

Defined in: async-retryer.ts:73

Base wait time in milliseconds between retries, or a function that returns the wait time

Default#

1000

enabled?#

optional enabled: boolean | (retryer) => boolean;

Defined in: async-retryer.ts:78

Whether the retryer is enabled, or a function that determines if it's enabled

Default#

true

initialState?#

optional initialState: Partial<AsyncRetryerState<TFn>>;

Defined in: async-retryer.ts:82

Initial state to merge with the default state

jitter?#

optional jitter: number;

Defined in: async-retryer.ts:87

Jitter percentage to add to retry delays (0-1). Adds randomness to prevent thundering herd.

Default#

0

key?#

optional key: string;

Defined in: async-retryer.ts:92

Optional key to identify this async retryer instance. If provided, the async retryer will be identified by this key in the devtools and PacerProvider if applicable.

maxAttempts?#

optional maxAttempts: number | (retryer) => number;

Defined in: async-retryer.ts:97

Maximum number of retry attempts, or a function that returns the max attempts

Default#

3

maxExecutionTime?#

optional maxExecutionTime: number;

Defined in: async-retryer.ts:102

Maximum execution time in milliseconds for a single function call before aborting

Default#

Infinity

maxTotalExecutionTime?#

optional maxTotalExecutionTime: number;

Defined in: async-retryer.ts:107

Maximum total execution time in milliseconds for the entire retry operation before aborting

Default#

Infinity

maxWait?#

optional maxWait: number | (retryer) => number;

Defined in: async-retryer.ts:112

Maximum wait time in milliseconds to cap retry delays, or a function that returns the max wait time

Default#

Infinity

onAbort()?#

optional onAbort: (reason, retryer) => void;

Defined in: async-retryer.ts:116

Callback invoked when the execution is aborted (manually or due to timeouts)

Parameters#

reason#

"manual" | "execution-timeout" | "total-timeout" | "new-execution"

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onError()?#

optional onError: (error, args, retryer) => void;

Defined in: async-retryer.ts:123

Callback invoked when any error occurs during execution (including retries)

Parameters#

error#

Error

args#

Parameters\<`TFn`\>

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onExecutionTimeout()?#

optional onExecutionTimeout: (retryer) => void;

Defined in: async-retryer.ts:131

Callback invoked when a single execution attempt times out (maxExecutionTime exceeded)

Parameters#

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onLastError()?#

optional onLastError: (error, retryer) => void;

Defined in: async-retryer.ts:135

Callback invoked when the final error occurs after all retries are exhausted

Parameters#

error#

Error

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onRetry()?#

optional onRetry: (attempt, error, retryer) => void;

Defined in: async-retryer.ts:139

Callback invoked before each retry attempt

Parameters#

attempt#

number

error#

Error

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onSettled()?#

optional onSettled: (args, retryer) => void;

Defined in: async-retryer.ts:143

Callback invoked after execution completes (success or failure) of each attempt

Parameters#

args#

Parameters\<`TFn`\>

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onSuccess()?#

optional onSuccess: (result, args, retryer) => void;

Defined in: async-retryer.ts:147

Callback invoked when execution succeeds

Parameters#

result#

Awaited\<`ReturnType`\<`TFn`\>>

args#

Parameters\<`TFn`\>

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

onTotalExecutionTimeout()?#

optional onTotalExecutionTimeout: (retryer) => void;

Defined in: async-retryer.ts:155

Callback invoked when the total execution time times out (maxTotalExecutionTime exceeded)

Parameters#

retryer#

AsyncRetryer\<`TFn`\>

Returns#

void

throwOnError?#

optional throwOnError: boolean | "last";

Defined in: async-retryer.ts:163

Controls when errors are thrown:

• 'last': Only throw the final error after all retries are exhausted

• true: Throw every error immediately (disables retrying)

• false: Never throw errors, return undefined instead

Default#

'last'