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

simple-limiter

v2.0.0

Published

simple synchronous rate limiter using the token-bucket algorithm

Downloads

7

Readme

simple-limiter

Build Status

Code Coverage Report
Documentation

simple synchronous library to limit rate by any key using the token-bucket algorithm

made to work with super-router

Usage

This is made to work with Super Router, but can work with any middleware. Simple Limiter doesn't handle request headers or response for you, but it does return values to make setting the headers and body easy:

const SuperRouter = require('super-router');
const RateLimiter = require('simple-limiter').RateLimiter;

module.exports = function() {
  const limiter = New RateLimiter({
    limit             : 20,
    incrementInterval : 5000,
    increment         : 1,
  });

  app.use({
    path    : '/thispath',
    handler : (opts) => {
      const request = opts.request;
      const response = opts.response;
      const key = `${request.yourKey}`;
      const tokensRemaining = limiter.getTokensRemaining(key);

      response.setHeader('X-Rate-Limit-Limit', `${limiter.config.limit}`);
      response.setHeader('X-Rate-Limit-Remaining', `${tokensRemaining}`);

      limiter.decrementTokens(key, 5);
    },
  });
};

If you change the default increment and decrement amounts to suit your project, which is recommended, you will run into situations where the user will have tokens remaining, but not enough to cover the cost of a request.

In this case, Simple Limiter throws a default error, which can be caught in middleware and served to the user as-is, or can be transformed to suit your project's standards:

try {
  limiter.decrementTokens(ip);
}
catch (error) {
  response.setBody({
    id      : 'RateLimitError',
    code    : 429,
    message : 'Too Many Requests',
  });
}