GitXplorerGitXplorer
v

async-retry

public
1857 stars
53 forks
30 issues

Commits

List of commits on branch main.
Unverified
9505be1f829ea297e7aff6c731ca3d5bd7052ed7

1.3.3

lleerob committed 3 years ago
Unverified
4b65583f1db095b2ba326e35ef856bc13def9a7b

1.3.2

lleerob committed 3 years ago
Verified
dce9623b8ac713f2c99cec46f27e2c2ec7e27160

Move to GitHub Actions. (#86)

lleerob committed 3 years ago
Verified
9b4eb33e62f2dc150bad3bf99c85193c01e85f68

Update all dependencies. (#83)

lleerob committed 3 years ago
Verified
766c48c6fca5b69189140f0a529b241b41b04c4e

ZEIT -> Vercel. (#82)

lleerob committed 3 years ago
Verified
2b1d3fe427fd3427963728bb64620872739b757b

Use Circleci (#67)

llucleray committed 5 years ago

README

The README file for this repository.

async-retry

Retrying made simple, easy, and async.

Usage

// Packages
const retry = require('async-retry');
const fetch = require('node-fetch');

await retry(
  async (bail) => {
    // if anything throws, we retry
    const res = await fetch('https://google.com');

    if (403 === res.status) {
      // don't retry upon 403
      bail(new Error('Unauthorized'));
      return;
    }

    const data = await res.text();
    return data.substr(0, 500);
  },
  {
    retries: 5,
  }
);

API

retry(retrier : Function, opts : Object) => Promise
  • The supplied function can be async or not. In other words, it can be a function that returns a Promise or a value.
  • The supplied function receives two parameters
    1. A Function you can invoke to abort the retrying (bail)
    2. A Number identifying the attempt. The absolute first attempt (before any retries) is 1.
  • The opts are passed to node-retry. Read its docs
    • retries: The maximum amount of times to retry the operation. Default is 10.
    • factor: The exponential factor to use. Default is 2.
    • minTimeout: The number of milliseconds before starting the first retry. Default is 1000.
    • maxTimeout: The maximum number of milliseconds between two retries. Default is Infinity.
    • randomize: Randomizes the timeouts by multiplying with a factor between 1 to 2. Default is true.
    • onRetry: an optional Function that is invoked after a new retry is performed. It's passed the Error that triggered it as a parameter.

Authors