mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-07 08:17:05 +00:00
Daniel Rosenwasser
df0fabe13b
* Update TypeScript version dependency in 'mock-knex'. * Account for 'promise-retry'. * Add 'x-ray' too.
28 lines
1.5 KiB
TypeScript
28 lines
1.5 KiB
TypeScript
// Type definitions for promise-retry 1.1
|
|
// Project: https://github.com/IndigoUnited/node-promise-retry
|
|
// Definitions by: Jamie Birch <https://github.com/shirakaba>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
import { WrapOptions } from "retry";
|
|
/**
|
|
* A function that is retryable, by having implicitly-bound params for both an error handler and an attempt number.
|
|
*
|
|
* @param retry The retry callback upon any rejection. Essentially throws the error on in the form of a { retried: err }
|
|
* wrapper, and tags it with a 'code' field of value "EPROMISERETRY" so that it is recognised as needing retrying. Call
|
|
* this from the catch() block when you want to retry a rejected attempt.
|
|
* @param attempt The number of the attempt.
|
|
* @returns A Promise for anything (eg. a HTTP response).
|
|
*/
|
|
type RetryableFn = ((retry: (error: any) => never, attempt: number) => Promise<any>);
|
|
/**
|
|
* Wrap all functions of the object with retry. The params can be entered in either order, just like in the original library.
|
|
*
|
|
* @param retryableFn The function to retry.
|
|
* @param options The options for how long/often to retry the function for.
|
|
* @returns The Promise resolved by the input retryableFn, or rejected (if not retried) from its catch block.
|
|
*/
|
|
declare function promiseRetry(retryableFn: RetryableFn, options?: WrapOptions): Promise<any>;
|
|
declare function promiseRetry(options: WrapOptions, retryableFn: RetryableFn): Promise<any>;
|
|
export = promiseRetry;
|