Interface RetryOptions

interface RetryOptions {
    maxRetries?: number;
    onError?: (err: unknown, request: Request) => boolean;
    onResponse?: (response: Response, request: Request) => boolean;
    onRetry?: (attempt: number, request: Request) => void | Request;
    retryDelay?: number | (retryCount: number) => number;
    returnLastResponse?: boolean;
    skip?: (request: Request) => boolean;
}

Properties

maxRetries? onError? onResponse? onRetry? retryDelay? returnLastResponse? skip?

Properties

OptionalmaxRetries

maxRetries?: number

max number of retries

Default

5

OptionalonError

onError?: (err: unknown, request: Request) => boolean

function that will be called if an error is thrown while calling the rest of the middleware chain, and should return whether the error should be retried

Default

() => true

OptionalonResponse

onResponse?: (response: Response, request: Request) => boolean

function that will be called whenever a response is received, and should return whether the response is valid (i.e. should be returned and not retried)

Default

response => response.status < 500

OptionalonRetry

onRetry?: (attempt: number, request: Request) => void | Request

function that will be called before a retry is attempted, and can be used to modify the request before proceeding

Type declaration

    • (attempt: number, request: Request): void | Request

    • Parameters

      • attempt: number

        current retry attempt (starts at 0)

      • request: Request

      Returns void | Request

OptionalretryDelay

retryDelay?: number | (retryCount: number) => number

delay between retries

Default

retryCount * 1000, up to 5000

OptionalreturnLastResponse

returnLastResponse?: boolean

if true, the last response will be returned if the number of retries is exceeded instead of throwing RetriesExceededError

Default

false

Optionalskip

skip?: (request: Request) => boolean

function that will be called before starting the retry loop. if it returns false, the retry loop will be skipped and the error will be thrown immediately

Default

() => false

Settings

Member Visibility

On This Page

Properties