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-rate-limiter-middleware

v1.0.6

Published

A simple in memory ip based rate limiter middleware for express apps.

Downloads

11

Readme

Simple Rate Limiter Middleware

npm version npm downloads

A simple in memory ip based rate limiter middleware for express apps.

Installation

# Using npm
> npm install simple-rate-limiter-middleware
# Using yarn or pnpm
> yarn/pnpm add simple-rate-limiter-middleware

Usage

Importing

This library is provided in ESM as well as CJS forms, and works with both Javascript and Typescript projects.

Import it in a CommonJS project (type: commonjs or no type field in package.json) as follows:

const { rateLimit, MemoryStore } = require("simple-rate-limiter-middleware");

Import it in a ESM project (type: module in package.json) as follows:

import { rateLimit, MemoryStore } from "simple-rate-limiter-middleware";

Examples

To use it in an API-only server where the rate-limiter should be applied to all requests:

const { rateLimit, MemoryStore } = require("simple-rate-limiter-middleware");

const rateLimiter = rateLimit({
  statusCode: 429,
  message: "Example response message.",
  legacyHeaders: false,
  standardHeaders: true,
  store: new MemoryStore(60, 10),
});

app.use(rateLimiter);

You can also create multiple instance and apply then to different places of your API.

Troubleshooting Proxy Issues

If you are behind a proxy/load balancer (usually the case with most hosting services, e.g. Heroku, Bluemix, AWS ELB, Nginx, Cloudflare, Akamai, Fastly, Firebase Hosting, Rackspace LB, Riverbed Stingray, etc.), the IP address of the request might be the IP of the load balancer/reverse proxy (making the rate limiter effectively a global one and blocking all requests once the limit is reached) or undefined. To solve this issue, add the following line to your code (right after you create the express application):

app.set("trust proxy", numberOfProxies);

Where numberOfProxies is the number of proxies between the user and the server.

For more information about the trust proxy setting, take a look at the official Express documentation.

Issues and Contributing

If you encounter a bug or want to see something added/changed, please go ahead and open an issue! If you need help with something, feel free to start a discussion!

Fell free to contribute to the library.