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

node-express-rate-limiter

v1.0.2

Published

A middleware package for Express.js that helps manage API rate limiting with customizable rules, logging, and IP whitelisting.

Downloads

8

Readme

node-express-rate-limiter

Description

A middleware package for Express.js that helps manage API rate limiting with customizable rules, logging, and IP whitelisting.

Features

  • Basic Rate Limiting: Limit the number of requests a user can make within a specified time period.
  • Customizable Rate Limiting Rules: Different limits for different routes or methods, user-specific rate limits.
  • IP Whitelisting: Whitelist certain IP addresses that are exempt from rate limiting.
  • Logging: Log rate limit events with customizable logging levels.
  • Rate Limit Exceeded Response: Customizable response when the rate limit is exceeded.
  • Redis or In-Memory Store: Support for storing rate limit data in Redis.
  • Flexible Identification: Identify users by IP address, API key, user ID, or custom identifier.
  • Retry-After Header: Include a Retry-After header in the response.
  • Burst Handling: Allow a short burst of requests beyond the limit with a cooldown period.
  • Middleware Compatibility: Compatible with other middleware.

Installation

npm install node-express-rate-limiter

## Usage
```ts
import express from 'express';
import rateLimiter from 'node-express-rate-limiter';

const app = express();

const limiter = rateLimiter({
  windowMs: 60000, // 1 minute
  max: 100, // limit each IP to 100 requests per windowMs
  store: {
    host: 'localhost',
    port: 6379
  },
  onLimitReached: (req, res) => {
    console.warn(`Rate limit reached for IP: ${req.ip}`);
  }
});

app.use(limiter);

app.get('/', (req, res) => {
  res.send('Hello, world!');
});

app.listen(3000, () => {
  console.log('Server running on port 3000');
});

Configuration Options

  • windowMs: The time window in milliseconds for rate limiting.
  • max: The maximum number of requests allowed within the time window.
  • keyGenerator: Function to generate a unique key for each user (default is req.ip).
  • onLimitReached: Function to call when the rate limit is reached.
  • headers: Whether to include rate limit headers in the response.
  • whitelist: Array of IP addresses to whitelist.
  • store: Configuration for the Redis store.
  • message: Custom message to send when the rate limit is exceeded.

License

[MIT]