feat: complete Ancestor quote bot with production-ready Docker support
This commit is contained in:
unfunny
309
node_modules/p-retry/index.d.ts
generated
vendored
309
node_modules/p-retry/index.d.ts
generated
vendored
@@ -1,267 +1,106 @@
|
||||
export class AbortError extends Error {
|
||||
import {OperationOptions} from 'retry';
|
||||
|
||||
declare class AbortErrorClass extends Error {
|
||||
readonly name: 'AbortError';
|
||||
readonly originalError: Error;
|
||||
|
||||
/**
|
||||
Abort retrying and reject the promise. No callback functions will be called.
|
||||
Abort retrying and reject the promise.
|
||||
|
||||
@param message - An error message or a custom error.
|
||||
@param message - Error message or custom error.
|
||||
*/
|
||||
constructor(message: string | Error);
|
||||
}
|
||||
|
||||
export type RetryContext = {
|
||||
readonly error: Error;
|
||||
readonly attemptNumber: number;
|
||||
readonly retriesLeft: number;
|
||||
readonly retriesConsumed: number;
|
||||
declare namespace pRetry {
|
||||
interface FailedAttemptError extends Error {
|
||||
readonly attemptNumber: number;
|
||||
readonly retriesLeft: number;
|
||||
}
|
||||
|
||||
interface Options extends OperationOptions {
|
||||
/**
|
||||
Callback invoked on each retry. Receives the error thrown by `input` as the first argument with properties `attemptNumber` and `retriesLeft` which indicate the current attempt number and the number of attempts left, respectively.
|
||||
|
||||
The `onFailedAttempt` function can return a promise. For example, to add a [delay](https://github.com/sindresorhus/delay):
|
||||
|
||||
```
|
||||
import pRetry = require('p-retry');
|
||||
import delay = require('delay');
|
||||
|
||||
const run = async () => { ... };
|
||||
|
||||
(async () => {
|
||||
const result = await pRetry(run, {
|
||||
onFailedAttempt: async error => {
|
||||
console.log('Waiting for 1 second before retrying');
|
||||
await delay(1000);
|
||||
}
|
||||
});
|
||||
})();
|
||||
```
|
||||
|
||||
If the `onFailedAttempt` function throws, all retries will be aborted and the original promise will reject with the thrown error.
|
||||
*/
|
||||
readonly onFailedAttempt?: (error: FailedAttemptError) => void | Promise<void>;
|
||||
}
|
||||
|
||||
type AbortError = AbortErrorClass;
|
||||
}
|
||||
|
||||
declare const pRetry: {
|
||||
/**
|
||||
The delay in milliseconds before the next retry attempt.
|
||||
Returns a `Promise` that is fulfilled when calling `input` returns a fulfilled promise. If calling `input` returns a rejected promise, `input` is called again until the max retries are reached, it then rejects with the last rejection reason.
|
||||
|
||||
This is calculated based on `minTimeout`, `factor`, `maxTimeout`, and `randomize` options.
|
||||
Does not retry on most `TypeErrors`, with the exception of network errors. This is done on a best case basis as different browsers have different [messages](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Checking_that_the_fetch_was_successful) to indicate this.
|
||||
See [whatwg/fetch#526 (comment)](https://github.com/whatwg/fetch/issues/526#issuecomment-554604080)
|
||||
|
||||
Note: The actual delay may be shorter if it would exceed `maxRetryTime`.
|
||||
This is `0` when the retry is skipped or when no retry will occur based on the checks completed before the current callback runs.
|
||||
*/
|
||||
readonly retryDelay: number;
|
||||
};
|
||||
|
||||
export type Options = {
|
||||
/**
|
||||
Callback invoked on each failure. Receives a context object containing the error and retry state information.
|
||||
|
||||
The function is called after `shouldConsumeRetry` and before `shouldRetry`, for all errors except `AbortError`.
|
||||
|
||||
The function is not called on `AbortError`.
|
||||
@param input - Receives the number of attempts as the first argument and is expected to return a `Promise` or any value.
|
||||
@param options - Options are passed to the [`retry`](https://github.com/tim-kos/node-retry#retryoperationoptions) module.
|
||||
|
||||
@example
|
||||
```
|
||||
import pRetry from 'p-retry';
|
||||
import pRetry = require('p-retry');
|
||||
import fetch from 'node-fetch';
|
||||
|
||||
const run = async () => {
|
||||
const response = await fetch('https://sindresorhus.com/unicorn');
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(response.statusText);
|
||||
// Abort retrying if the resource doesn't exist
|
||||
if (response.status === 404) {
|
||||
throw new pRetry.AbortError(response.statusText);
|
||||
}
|
||||
|
||||
return response.json();
|
||||
return response.blob();
|
||||
};
|
||||
|
||||
const result = await pRetry(run, {
|
||||
onFailedAttempt: ({error, attemptNumber, retriesLeft, retriesConsumed, retryDelay}) => {
|
||||
console.log(`Attempt ${attemptNumber} failed. Retrying in ${retryDelay}ms. ${retriesLeft} retries left.`);
|
||||
// 1st request => Attempt 1 failed. Retrying in 1000ms. 5 retries left.
|
||||
// 2nd request => Attempt 2 failed. Retrying in 2000ms. 4 retries left.
|
||||
// …
|
||||
},
|
||||
retries: 5
|
||||
});
|
||||
(async () => {
|
||||
console.log(await pRetry(run, {retries: 5}));
|
||||
|
||||
console.log(result);
|
||||
```
|
||||
// With the `onFailedAttempt` option:
|
||||
const result = await pRetry(run, {
|
||||
onFailedAttempt: error => {
|
||||
console.log(`Attempt ${error.attemptNumber} failed. There are ${error.retriesLeft} retries left.`);
|
||||
// 1st request => Attempt 1 failed. There are 4 retries left.
|
||||
// 2nd request => Attempt 2 failed. There are 3 retries left.
|
||||
// …
|
||||
},
|
||||
retries: 5
|
||||
});
|
||||
|
||||
The `onFailedAttempt` function can return a promise. For example, to add a [delay](https://github.com/sindresorhus/delay):
|
||||
|
||||
@example
|
||||
```
|
||||
import pRetry from 'p-retry';
|
||||
import delay from 'delay';
|
||||
|
||||
const run = async () => { … };
|
||||
|
||||
const result = await pRetry(run, {
|
||||
onFailedAttempt: async () => {
|
||||
console.log('Waiting for 1 second before retrying');
|
||||
await delay(1000);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
If the `onFailedAttempt` function throws, all retries will be aborted and the original promise will reject with the thrown error.
|
||||
*/
|
||||
readonly onFailedAttempt?: (context: RetryContext) => void | Promise<void>;
|
||||
|
||||
/**
|
||||
Decide if a retry should occur based on the context. Returning true triggers a retry, false aborts with the error.
|
||||
|
||||
The function is called after `onFailedAttempt` and `shouldConsumeRetry`.
|
||||
|
||||
The function is not called on `AbortError`, `TypeError` (except network errors), or if `retries` or `maxRetryTime` are exhausted.
|
||||
|
||||
@example
|
||||
```
|
||||
import pRetry from 'p-retry';
|
||||
|
||||
const run = async () => { … };
|
||||
|
||||
const result = await pRetry(run, {
|
||||
shouldRetry: ({error, attemptNumber, retriesLeft}) => !(error instanceof CustomError)
|
||||
});
|
||||
```
|
||||
|
||||
In the example above, the operation will be retried unless the error is an instance of `CustomError`.
|
||||
|
||||
If the `shouldRetry` function throws, all retries will be aborted and the original promise will reject with the thrown error.
|
||||
*/
|
||||
readonly shouldRetry?: (context: RetryContext) => boolean | Promise<boolean>;
|
||||
|
||||
/**
|
||||
Decide if this failure should consume a retry from the `retries` budget.
|
||||
|
||||
When `false` is returned, the failure will not consume a retry or increment backoff values, but is still subject to `maxRetryTime`.
|
||||
|
||||
The function is called before `onFailedAttempt` and `shouldRetry`.
|
||||
|
||||
The function is not called on `AbortError`.
|
||||
|
||||
@example
|
||||
```
|
||||
import pRetry from 'p-retry';
|
||||
|
||||
const run = async () => { … };
|
||||
|
||||
const result = await pRetry(run, {
|
||||
retries: 2,
|
||||
shouldConsumeRetry: ({error, retriesLeft}) => {
|
||||
console.log(`Retries left: ${retriesLeft}`);
|
||||
return !(error instanceof RateLimitError);
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
In the example above, `RateLimitError`s will not decrement the available `retries`.
|
||||
|
||||
If the `shouldConsumeRetry` function throws, all retries will be aborted and the original promise will reject with the thrown error.
|
||||
*/
|
||||
readonly shouldConsumeRetry?: (context: RetryContext) => boolean | Promise<boolean>;
|
||||
|
||||
/**
|
||||
The maximum amount of times to retry the operation. Must be a non-negative integer or `Infinity`.
|
||||
|
||||
@default 10
|
||||
*/
|
||||
readonly retries?: number;
|
||||
|
||||
/**
|
||||
The exponential factor to use.
|
||||
|
||||
@default 2
|
||||
*/
|
||||
readonly factor?: number;
|
||||
|
||||
/**
|
||||
The number of milliseconds before starting the first retry.
|
||||
|
||||
Set this to `0` to retry immediately with no delay.
|
||||
|
||||
@default 1000
|
||||
*/
|
||||
readonly minTimeout?: number;
|
||||
|
||||
/**
|
||||
The maximum number of milliseconds between two retries.
|
||||
|
||||
@default Infinity
|
||||
*/
|
||||
readonly maxTimeout?: number;
|
||||
|
||||
/**
|
||||
Randomizes the timeouts by multiplying with a factor between 1 and 2.
|
||||
|
||||
@default false
|
||||
*/
|
||||
readonly randomize?: boolean;
|
||||
|
||||
/**
|
||||
The maximum time (in milliseconds) that the retried operation is allowed to run.
|
||||
|
||||
@default Infinity
|
||||
|
||||
Measured with a monotonic clock (`performance.now()`) so system clock adjustments do not affect the limit.
|
||||
*/
|
||||
readonly maxRetryTime?: number;
|
||||
|
||||
/**
|
||||
You can abort retrying using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
|
||||
|
||||
```
|
||||
import pRetry from 'p-retry';
|
||||
|
||||
const run = async () => { … };
|
||||
const controller = new AbortController();
|
||||
|
||||
cancelButton.addEventListener('click', () => {
|
||||
controller.abort(new Error('User clicked cancel button'));
|
||||
});
|
||||
|
||||
try {
|
||||
await pRetry(run, {signal: controller.signal});
|
||||
} catch (error) {
|
||||
console.log(error.message);
|
||||
//=> 'User clicked cancel button'
|
||||
}
|
||||
console.log(result);
|
||||
})();
|
||||
```
|
||||
*/
|
||||
readonly signal?: AbortSignal | undefined;
|
||||
<T>(
|
||||
input: (attemptCount: number) => PromiseLike<T> | T,
|
||||
options?: pRetry.Options
|
||||
): Promise<T>;
|
||||
|
||||
/**
|
||||
Prevents retry timeouts from keeping the process alive.
|
||||
AbortError: typeof AbortErrorClass;
|
||||
|
||||
Only affects platforms with a `.unref()` method on timeouts, such as Node.js.
|
||||
|
||||
@default false
|
||||
*/
|
||||
readonly unref?: boolean;
|
||||
// TODO: remove this in the next major version
|
||||
default: typeof pRetry;
|
||||
};
|
||||
|
||||
/**
|
||||
Returns a `Promise` that is fulfilled when calling `input` returns a fulfilled promise. If calling `input` returns a rejected promise, `input` is called again until the max retries are reached, it then rejects with the last rejection reason.
|
||||
|
||||
Does not retry on most `TypeErrors`, with the exception of network errors. This is done on a best case basis as different browsers have different [messages](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Checking_that_the_fetch_was_successful) to indicate this. See [whatwg/fetch#526 (comment)](https://github.com/whatwg/fetch/issues/526#issuecomment-554604080)
|
||||
|
||||
Non-network `TypeError`s always abort retries, even if `shouldConsumeRetry` or `shouldRetry` would otherwise allow another attempt.
|
||||
|
||||
@param input - Receives the number of attempts as the first argument and is expected to return a `Promise` or any value.
|
||||
@param options - Options for configuring the retry behavior.
|
||||
|
||||
@example
|
||||
```
|
||||
import pRetry, {AbortError} from 'p-retry';
|
||||
|
||||
const run = async () => {
|
||||
const response = await fetch('https://sindresorhus.com/unicorn');
|
||||
|
||||
// Abort retrying if the resource doesn't exist
|
||||
if (response.status === 404) {
|
||||
throw new AbortError(response.statusText);
|
||||
}
|
||||
|
||||
return response.blob();
|
||||
};
|
||||
|
||||
console.log(await pRetry(run, {retries: 5}));
|
||||
```
|
||||
*/
|
||||
export default function pRetry<T>(
|
||||
input: (attemptNumber: number) => PromiseLike<T> | T,
|
||||
options?: Options
|
||||
): Promise<T>;
|
||||
|
||||
/**
|
||||
Wrap a function so that each call is automatically retried on failure.
|
||||
|
||||
@example
|
||||
```
|
||||
import {makeRetriable} from 'p-retry';
|
||||
|
||||
const fetchWithRetry = makeRetriable(fetch, {retries: 5});
|
||||
|
||||
const response = await fetchWithRetry('https://sindresorhus.com/unicorn');
|
||||
```
|
||||
*/
|
||||
export function makeRetriable<Arguments extends readonly unknown[], Result>(
|
||||
function_: (...arguments_: Arguments) => PromiseLike<Result> | Result,
|
||||
options?: Options
|
||||
): (...arguments_: Arguments) => Promise<Result>;
|
||||
export = pRetry;
|
||||
|
||||
Reference in New Issue
Block a user