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

promise-throttle-bucket

v1.0.0

Published

Throttles a promise-returning function using the token-bucket algorithm

Downloads

12

Readme

promise-throttle-bucket

Throttles a promise-returning function using the token-bucket algorithm.

Motivation

Many AWS APIs are throttled using the token-bucket algorithm. For instance, to prevent hitting the EC2 rate limits, the functions that call the AWS API can be wrapped and throttled.

Install

npm install promise-throttle-bucket

Usage

const pThrottleBucket = require('promise-throttle-bucket')

const throttledFn = pThrottleBucket(
  describeEc2Instance,
  { max: 100, refill: 20 }
)

Promise.all([/* array of 150 instances */].map(throttledFn))
    // After 0s, described instances 0-99
    // After 1s, described instances 100-119
    // After 2s, described instances 120-139
    // After 3s, described instances 140-150
  .then(function (instances) {
    // Resolves after all the instances were described.
  })

API

pThrottleBucket(fn, options)

Returns a throttled function.

fn

Type: Function

A function.

options

Type: object

options.max

Type: number

The maximum number of tokens in the bucket.

options.refill

Type: number

The number of refill tokens per interval in milliseconds.

options.interval?

Type: number Default: 1000

The refill interval in milliseconds.

throttledFn

Type: function

The throttled version of fn. It resolves when fn() resolves and rejects if it rejects. The time it takes to settle depends on how many calls are in the queue and the throttling parameters.