You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
30 lines
1.1 KiB
30 lines
1.1 KiB
4 months ago
|
import type { Operation } from "../core/index.js";
|
||
|
|
/**
|
||
|
|
* Advanced mode: a function that determines both whether a particular
|
||
|
|
* response should be retried.
|
||
|
|
*/
|
||
|
|
export interface RetryFunction {
|
||
|
|
(count: number, operation: Operation, error: any): boolean | Promise<boolean>;
|
||
|
|
}
|
||
|
|
export interface RetryFunctionOptions {
|
||
|
|
/**
|
||
|
|
* The max number of times to try a single operation before giving up.
|
||
|
|
*
|
||
|
|
* Note that this INCLUDES the initial request as part of the count.
|
||
|
|
* E.g. maxTries of 1 indicates no retrying should occur.
|
||
|
|
*
|
||
|
|
* Defaults to 5. Pass Infinity for infinite retries.
|
||
|
|
*/
|
||
|
|
max?: number;
|
||
|
|
/**
|
||
|
|
* Predicate function that determines whether a particular error should
|
||
|
|
* trigger a retry.
|
||
|
|
*
|
||
|
|
* For example, you may want to not retry 4xx class HTTP errors.
|
||
|
|
*
|
||
|
|
* By default, all errors are retried.
|
||
|
|
*/
|
||
|
|
retryIf?: (error: any, operation: Operation) => boolean | Promise<boolean>;
|
||
|
|
}
|
||
|
|
export declare function buildRetryFunction(retryOptions?: RetryFunctionOptions): RetryFunction;
|
||
|
|
//# sourceMappingURL=retryFunction.d.ts.map
|