npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pxtrn/async-backoff

v2.0.2

Published

Backoff failing async calls

Downloads

2

Readme

@pxtrn/async-backoff

Backoff failing async calls until they successfully complete. Usefull for recoverable errors that most likely go away on retry. For example errors like ENOTFOUND, EHOSTUNREACH etc. on network calls or EBUSY on file system calls.

Installation

npm install --save @pxtrn/async-backoff

Usage

Javascript

const { backoff } = require('@pxtrn/async-backoff');

let counter = 1;

async function request() {
  console.log(`request number: ${counter}`);

  if(counter < 5) {
    counter ++;
    throw new Error('Some Network error');
  }

  console.log(`successfully requestd resource`);
  return true;
}


(async function() {
  try {
    const result = await backoff(request, {maxAttempts: 5, retryTimeout: 100});
  } catch(err) {
    console.error(`Could not request resource`);
  }
})();

Typescript

import { backoff } from '@pxtrn/async-backoff';

let counter = 1;

interface IUser {name: string; email: string};

async function request(): Promise<IUser> {
  console.log(`request number: ${counter}`);

  if(counter < 5) {
    counter ++;
    throw new Error('Some Network error');
  }

  console.log(`successfully requestd resource`);
  return {name: 'Bob', email: '[email protected]'};
}


(async function() {
  try {
    const result = await backoff<IUser>(request, {maxAttempts: 5, retryTimeout: 100});
    console.log('Got result', result);
  } catch(err) {
    console.error(`Could not request resource`);
  }
})();

Parameters

  • fn {async Function} Async function to await
  • options {Object}
    • maxAttempts: {Integer} Max number of function calls
    • retryTimeout: {Integer} ms to wait. Only for default delayStrategy (return attempts * retryTimeout)
    • retryStrategy: {Function(err)} return boolean true if another call to fn should be tryed, even maxAttempts has not been reached yet
    • delayStrategy: {Function(attempts)} return an integer in ms for which the next attempt should be delayed
    • signal: {AbortSignal}

Custom retry strategy

await backoff(request, {
  maxAttempts: 5,
  retryStrategy: (err) => {
    const retryErrors = ['ECONNRESET', 'ENOTFOUND', 'ESOCKETTIMEDOUT'];
    return retryErrors.includes(err.code);
  }
});

Custom delay strategy

await backoff(request, {
  maxAttempts: 5,
  delayStrategy: (attempts) => {
    return Math.min((Math.pow(2, attempts) * 100), 5e3);
  }
});

Aborting a running backoff

Note this does only abort the backoff itself, not the async function passed.


const ac = new AbortController();
setTimeout(() => ac.abort(), 2e3);


await backoff(request, {
  signal: ac.signal
});