Registry / security / express-rate-limit-redis

express-rate-limit-redis

JSON →
library0.0.4jsnpmunverified

An Express rate-limiting middleware using Redis as storage. Current version 0.0.4. Low-traffic, single-contributor project. Allows per-route rate limits with configurable window and max requests. Uses Redis for distributed state. No active maintenance since 2019. Provides TypeScript types, but minimal documentation.

security
npm install express-rate-limit-redis
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · EXPRESS-RATE-LIMIT
E
express-rate-limit-redis
securityjavascriptv0.0.4
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
✓ const RateLimiter = require('express-rate-limit-redis')
✗ import RateLimiter from 'express-rate-limit-redis'
Package is CJS only; ESM import may fail without bundler.
RateLimiterOptions
✓ import { RateLimiterOptions } from 'express-rate-limit-redis'
Type import for TypeScript users, available since types shipped.

Sets up Express server with Redis-backed rate limiter on a route, limiting to 3 requests per minute.

const express = require('express'); const RateLimiter = require('express-rate-limit-redis'); const Redis = require('ioredis'); const client = new Redis(); const app = express(); const limiter = RateLimiter({ client, id: 'verify-phone-number', max: 3, windowMs: 60 * 1000, }); app.use('/verify-phone-number', limiter); app.get('/verify-phone-number', async (req, res) => { res.json({ msg: 'ok' }); }); app.listen(8080);
Debug
Known issues
breakingVersion 0.0.4 uses a different signature than earlier versions.
fix
Update to 0.0.4 and pass options object with 'client', 'id', 'max', 'windowMs'.
affects: <0.0.4
deprecatedNo updates since 2019; rely at your own risk.
fix
Consider using 'express-rate-limit' with 'rate-limit-redis' instead.
affects: >=0.0.0
gotchaTimeout errors can occur if Redis is not reachable.
fix
Add error handling to middleware creation.
affects: >=0.0.0
Errors
Common errors & fixes
Error: RateLimiter is not a function
Incorrect import or require.
fix
Use `const RateLimiter = require('express-rate-limit-redis')`.
TypeError: Cannot destructure property 'client' of 'options' as it is undefined.
Missing or malformed options object.
fix
Pass an object with required properties: { client, id, max, windowMs }.
Upgrade
Version history
0.0.4latest on npm
Audit
Dependencies
expressrequiredPeer dependency required as middleware
ioredisoptionalRedis client for storage
Agent activity
23 hits · last 30 days
node
20
Amazon
1
OpenAI (training)
1
Resources
githubhttps://github.com/timqian/express-rate-limit-redis ↗
packageexpress-rate-limit-redis ↗
homepagehttps://github.com/timqian/express-rate-limit-redis#readme ↗
express-rate-limit-redis — npm install express-rate-limit-redis · libregistry