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

express-rate-limiter-redis

v1.1.0

Published

Express Rate Limiter, using Redis as the key value store.

Downloads

9

Readme

Express Rate Limiter - Redis

npmlicense

Rate limiter middleware for express applications, using a redis store as back-end.

This limiter has two kinds of limits: an inner and outer limit. It limites based on user ip.

The inner limit is against hammering (e.g. only 3 calls allowed per second). The outer limit is for protecting against over-use. (e.g. max 60 times per two minutes).

Usage

Install

npm install express-rate-limiter-redis --save

First, create a new Limiter;

var Limiter = require('express-rate-limiter-redis/limiter'), //For easy usage, this redirects to express-rate-limiter (The main module)
    RedisStore = require('express-rate-limiter-redis'),
    store = new RedisStore(),
    limiter = new Limiter({ db : store });

The RedisStore defaults to 127.0.0.1 as host and 6379 as port. These can be overwritten by passing them to the ctor, like so:

var store = new RedisStore({
    host: '127.0.0.1',
    port: 6379
});

Or when you have a url:

var store = new RedisStore({
    url: 'redis://127.0.0.1:6379'
});

In case the url contains auth data, the client will automatically authenticate.

Instead of passing along options, it is also possible to pass a different redis store (or mock) with the same signature:

var redis = require("redis"),
        client = redis.createClient();

var store = new RedisStore({
    client: client
});

Options different than the ones above, will be used to pass to the redisClient when created internally.

Afterwards, use the limiter to create an express middleware for the express methods you want to rate limit.

app.post('/', limiter.middleware(), function(req, res) {   

});

Anything written in the callback will now be rate limited.

Since the connection to the redis server causes an asynchronous overhead, it is recommended to increase the inner expiration time. Leaving it on it's default, 3 seconds, will result in possible race conditions that can't be avoided. This can be configured as follows:

    var limiter = new Limiter({
        db: redisStore,
        innerTimeLimit: 10000,
        innerLimit: 15
    });

More info

For more info, see expres-rate-limiter.