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

curtain

v0.0.81

Published

rate-limiter using Redis

Downloads

6

Readme

Curtain

This library serves as Express middleware designed to make a yes/no decision about whether to admit a request or to determine that a request has exceeed a threshold and should be rejected with a HTTP 429 or other relevant HTTP response.

Usage

(See the /test folder in the project for more examples)


const RateLimiter = require('curtain');

var rlm = new RateLimiter({
    redis: {
        port: 6379,
        host: '127.0.0.1',
        db: 0
    }
});


app.use(rlm.limit({

    maxReqsPerPeriod: 150,          // maximum number of requests that are allowed to occur during a window
    periodMillis: 3000,             // the window period in milliseconds
    identifier: 'ip'                // string representing what value to read off the req object
    

}), function requestLimitExceeded(err, req, res, next) {

    //some error occured, most likely an error representing that the request rate was exceeded by the latest request
    next(err);

}, function requestIsOk(req, res, next) {

    //the new request is within limits
    next();
});

you can also pass in an existing Redis client like so:

const RateLimiter = require('curtain');

var rlm = new RateLimiter({
    redis: {
        client: yourClient 
    }
});

Note: This library calls your error handling middleware. When the rate limit is exceeded by the newest request it will call your promixate error handling middleware; this same middleware will also be called if any other types of errors occur. All errors (whether they are Redis errors or rate limit errors) should be handled by you like this:

app.use(rlm.limit({

    maxReqsPerPeriod: 150,
    periodMillis: 3000,
    identifier: 'ip'

}), function curtainErrorOccurred(err, req, res, next) {

        switch (err.type) {  
            case rlm.errors.RATE_EXCEEDED:  //Rate has been exceeeded, do with this as you will
                res.set('Retry-After',2);
                return res.status(429).json({error: 'Request rate exceeded limit.'});
            case rlm.errors.REDIS_ERROR:
                return next(err);
            case rlm.errors.NO_KEY:  // whatever you chose to use as your request unique identifier, there was a problem finding it on the request stream object
                return next(err);
            case rlm.errors.BAD_ARGUMENTS:  //if you have some dynamicism in your project, then it's possible that you could pass bad args at some point in runtime
                return next(err);
            default:
                next(new Error('The NPM curtain library broke because it sent an unexpected error, what a POS'))
        }

}, function requestIsOk(req, res, next) {

    next();
    
});

That might look like this:



app.use(function(req,res,next){

   req['foo-bar'] = 'some-unique-request-id-for-your-app';
   next();

}, rlm.limit({

    maxReqsPerPeriod: 150,          // maximum number of requests that are allowed to occur during a window
    periodMillis: 3000,             // the window period in milliseconds
    identifier: 'foo-bar'           // string representing what value to read off the req object
    

}), function requestLimitExceeded(err, req, res, next) {

    //some error occured, most likely an error representing that the request rate was exceeded by the latest request
    next(err);

}, function requestIsOk(req, res, next) {

    //the new request is within limits
    next();
});