@augment-vir/common/dist/augments/function/retry.js

A collection of augments, helpers types, functions, and classes for any JavaScript environment.

import { ensureErrorAndPrependMessage, wait } from '@augment-vir/core';
/**
 * Calls `callback` until it doesn't throw an error or throws an error when `maxRetries` is reached.
 * Similar to the `waitUntil` guard from '@augment-vir/assert' but doesn't check the callback's
 * output.
 *
 * @category Function
 * @category Package : @augment-vir/common
 * @example
 *
 * ```ts
 * import {callWithRetries} from '@augment-vir/common';
 *
 * const result = callWithRetries(5, () => {
 *     if (Math.random() < 0.5) {
 *         return 'done';
 *     } else {
 *         throw new Error();
 *     }
 * });
 * ```
 *
 * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
 */
export function retry(maxRetries, callback, options = {}) {
    try {
        const result = callback();
        if (result instanceof Promise) {
            return result.catch(async (error) => {
                if (maxRetries <= 1) {
                    throw ensureErrorAndPrependMessage(error, 'Retry max reached');
                }
                else {
                    if (options.interval) {
                        await wait(options.interval);
                    }
                    return retry(maxRetries - 1, callback, options);
                }
            });
        }
        else {
            return result;
        }
    }
    catch (error) {
        if (maxRetries <= 1) {
            throw ensureErrorAndPrependMessage(error, 'Retry max reached');
        }
        else if (options.interval) {
            return wait(options.interval).then(() => retry(maxRetries - 1, callback, options));
        }
        else {
            return retry(maxRetries - 1, callback, options);
        }
    }
}