Interface RetryOptions

interface RetryOptions {
    retries: number;
    retryAfterJitter: (() => number);
    retryBackoff: BackoffOptions;
    retryFailureCutoff: number;
    shouldRetry: ((status: number) => boolean);
    tryBackoff: BackoffOptions;
}

Properties

retries: number

The maximum number of retries for a single request. Default: 1 For requests with side effects, this should be set to 0.

"Various studies have collected data which shows that one max retry is sufficient to achieve 99.999% success. The idea is that a truly transient failure should succeed on the first retry. And if the retry fails then it is likely more than a transient failure and additional retries are exhausting resources in the system for no benefit."

retryAfterJitter: (() => number)

If there is a retry-after header, add the returned amount of time (in seconds) to prevent clustered retry behavior.

retryBackoff: BackoffOptions

Retry backoff timing.

retryFailureCutoff: number

The number of consecutive failures before retries are no longer attempted, only tries.

shouldRetry: ((status: number) => boolean)

Given the network status code, returns true if the fetch should retry.

tryBackoff: BackoffOptions

First try backoff timing.