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

@jil/backoff

v0.3.0

Published

A utility that allows retrying a function with an exponential delay between attempts.

Downloads

10

Readme

@jil/backoff

A utility that allows retrying a function with an exponential delay between attempts.

Installation

npm i @jil/backoff

Usage

The backoff<T> function takes a promise-returning function to retry, and an optional BackfofOptions object. It returns a CancelablePromise<T>.

declare function backoff<T>(
  runner: (token: CancellationToken) => Promise<T>,
  options?: BackoffOptions,
): CancelablePromise<T>;

Here is an example retrying a function that calls a hypothetical weather endpoint:

import {backoff} from '@jil/backoff';

function getWeather() {
  return fetch('weather-endpoint');
}

async function main() {
  try {
    const response = await backoff(() => getWeather());
    // process response
  } catch (e) {
    // handle error
  }
}

main();

Example for cancelation

import {backoff} from '@jil/backoff';

function getWeather(token: CancellationToken) {
  const request = fetch('weather-endpoint');
  token.onCancellationRequested(() => request.abort());
  return request;
}

async function main() {
  try {
    const request = backoff(() => getWeather());
    setTimeout(() => request.cancel(), 2000);
    // process response
  } catch (e) {
    // handle error
    // if canceld, a CanceledError throws
  }
}

main();

BackoffOptions

  • strategy?: BackoffStrategyType | BackoffStrategyCtor

    Specify the strategy type or strategy class. Built in strategies are exponential and fibonacci.

    Defaults to fibonacci

  • jitter?: JitterType | Jitter

    Decides whether a jitters should be applied to the delay. Possible values are full and none.

    Defaults to none

  • initialDelay?: number

    The delay, in milliseconds, before executing the function for the first time.

    Defaults to 100

  • maxDelay?: number

    The maximum delay, in milliseconds, between two consecutive attempts.

    Defaults to Infinity, must be greater than initialDelay

  • maxNumOfAttempts?: number

    The maximum number of times to attempt the function.

    Defaults to 10

  • factor?: number

    The exponential factor. The initialDelay is multiplied by the factor to increase the delay between reattempts.

    Defaults to 2, must be greater than 1

  • delayFirstAttempt?: boolean

    Decides whether the initialDelay should be applied before the first call. If false, the first call will occur without a delay.

    Defaults to false

  • retry?: (e: any, attemptNumber: number) => ValueOrPromise<any>

    The retry function can be used to run logic after every failed attempt (e.g. logging a message, assessing the last error, etc.). It is called with the last error and the upcoming attempt number. Returning true will retry the function as long as the numOfAttempts has not been exceeded. Returning false will end the execution.

    Defaults to return ture always