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-light-limiter

v1.0.1

Published

Express light-weight middleware for rate-limiting

Downloads

5

Readme

express-light-limiter NPM version dependencies Status devDependencies Status Status

Smart express lightweight middleware for rate-limiting based on Zones to prevent memory leaks

Install

  • Install module from npm:
$ npm install --save express-light-limiter

Usage

import express from 'express';
import limiter from 'express-light-limiter';

let app = express();

const limiterConfig = {
  quantum: 10 * 1000, // 10 seconds
  maxRequestsPerQuantum: 20, // requests restriction is 20 for a single quantum
  lookup: 'connection.remoteAddress', // it can be an array or a function
  error: new HttpError('Too many requests', 429) // your custom error object
};

app.get('/api/action', [ limiter(limiterConfig) ], function (req, res) {
  res.send(200, 'ok')
})

API options

limiter(options)
  • lookup: Function|String|Array.<String> value lookup on the request object. Can be a single value, array or function. See examples below. Default is connection.remoteAddress.

  • quantum: Number unit of time for counting requests. Default is 5 * 1000 (5 sec).

  • maxRequestsPerQuantum: Number number of requests that allowed in a single quantum of time.

  • error: Object optional param allowing throw a custom error in next function

Examples

// limit by IP address
limiter({
  ...
  lookup: 'connection.remoteAddress'
  ...
})

// or if you are behind a trusted proxy (like nginx)
limiter({
  lookup: 'headers.x-forwarded-for'
})

// by user (assuming a user is logged in with a valid id)
limiter({
  lookup: 'user.id'
})

// limit users by their id or IP (if user's id is not available)
limiter({
  lookup: ['user.id', 'connection.remoteAddress']
})

// with a function
limiter({
  lookup(req) {
    return req.connection.remoteAddress || req.user.id || req.ip;
  }
})

Separate methods

// limiter with default options
app.get('/user', limiter(), (req, res, next) => {
  User.findOne(req.user.id).then(result => {
    res.json(result);
  }).catch(next);
});

app.get('/news', limiter({ quantum: 60 * 1000, maxRequestsPerQuantum: 120 }), (req, res, next) => {
  User.findAll().then(result => {
    res.json(result);
  }).catch(next);
})

License

MIT © 2016 Alexander Belov