npmpackage.info

Gathering detailed insights and metrics for koa-ratelimit-redis

Other packages similar to koa-ratelimit-redis

koa-redis-ratelimit

1.0.1

Rate limiting middleware backed by Redis for Koa v2+, built for CrocodileJS

koa-ratelimit-redis

koa ratelimit by redis

0.1.1

JavaScript

1.05 kB

674 2.6

Installations

npm install koa-ratelimit-redis

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.9.0

NPM Version

5.5.1 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

dillonliang224

Download Statistics

Total Downloads

674

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

2 Stars

2 Commits

2 Watching

1 Branches

1 Contributors

Bundle Size

3.96 kB

Minified

1.05 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

0.1.1

Package Id

koa-ratelimit-redis@0.1.1

Unpacked Size

15.11 kB

Size

3.09 kB

File Count

NPM Version

5.5.1

Node Version

8.9.0

Total Downloads

Cumulative downloads

Total Downloads

674

Last day

Compared to previous day

Last week

100%

Compared to previous week

Last month

33.3%

Compared to previous month

Last year

-13.1%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

babel-plugin-transform-runtime babel-preset-es2015 babel-preset-stage-0

Versions

Koa Rate Limit By Redis

Note: This module is based on express-rate-limit.

Install

npm install --save koa-ratelimit-redis

Usage

1const Redis = require('ioredis')
2const RateLimit = require('koa-ratelimit-redis').RateLimit
3const RedisStore = require('koa-ratelimit-redis').RedisStore
4const Koa = require('koa')
5const router = require('koa-router')()
6
7const client = new Redis({
8    host: '127.0.0.1',
9    port: '6379',
10    db: 0,
11})
12
13function skip(ctx) {
14    return false
15}
16
17function koaHandler(ctx) {
18    ctx.body = {
19        ok: false,
20        code: 'RATE_LIMIT',
21        msg: 'RATE_LIMIT',
22    }
23}
24
25function defaultRateLimiter(max = 5, expiry = 60, handler = koaHandler) {
26    return new RateLimit({
27        store: new RedisStore({
28            client,
29            expiry: expiry,
30            prefix: 'rl:'
31        }),
32        keyGenerator(ctx) {
33            return `default::${ctx.method}:${ctx.path}:${ctx.ip}`
34        },
35        max: max,
36        statusCode: 200,
37        handler,
38        skip,
39    })
40}
41
42function doHello(ctx) {
43    ctx.body = 'hello world'
44}
45
46const app = new Koa()
47
48router.get('/hello', defaultRateLimiter(), doHello)
49router.get('/world', defaultRateLimiter(1, 30, (ctx) => {
50    ctx.body = {
51        msg: 'RATE_LIMIT'
52    }
53}), doHello)
54
55app.use(router.middleware())
56
57app.listen(8080)
58

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

2.6

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More