Git Product home page Git Product logo

tjenkinson / exponential-rate-limit Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 559 KB

A small library which handles decaying exponential backoff. This is useful if you want to start throttling something whilst it is going wrong, but recover once things start working again.

Home Page: https://exponential-rate-limit.netlify.com/demo.html

License: Apache License 2.0

TypeScript 88.53% HTML 11.47%
exponential exponential-backoff retry delay backoff typescript decay

exponential-rate-limit's Introduction

npm version

Exponential Rate Limit

A small library which handles decaying exponential backoff. This is useful if you want to start throttling something whilst it is going wrong, but recover once things start working again.

Demo

The demo source is in "demo.ts".

To run the demo locally run npm run start.

It is also hosted here (thanks to Netify).

Usage

import { JobQueue, defaultDelayFunction } from './exponential-rate-limit';

const queue = new JobQueue({
  /**
   * The maximum time (seconds) between jobs executing.
   */
  maxInterval: 5
  /**
   * The delay function.
   */
  delayFunction: defaultDelayFunction
});

const { remove } = queue.enqueue(({ enqueueTime } => {
  console.log('Executing', enqueueTime);
});

Example

The following example implements throttledFetch, which will start delaying future executions exponentially (up to the default 5 seconds) every time a request fails or does not respond with status 200.

Every time there is a 200 response, the delays will also start getting shorter again. As time passes without any jobs being executed, the delay the next job would incur also decreases.

import { JobQueue } from './exponential-rate-limit';

const jobQueue = new JobQueue(); // default options

function throttledFetch(...fetchArgs): Promise<Response> {
  return new Promise((resolve) => {
    jobQueue.enqueue(() => {
      const fetchPromise = fetch(...fetchArgs);
      resolve(fetchPromise);
      return fetchPromise.then((response) => response.status === 200);
    });
  });
}

Browser

This can also be used in the browser thanks to jsDelivr:

<head>
  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/exponential-rate-limit@1"></script>
  <script type="text/javascript">
    var queue = new ExponentialRateLimit.JobQueue();
  </script>
</head>

exponential-rate-limit's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar github-actions[bot] avatar tjenkinson avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

exponential-rate-limit's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.