Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scttcper/koa-simple-ratelimit
Simple rate limiter for Koa.js v2 web framework
https://github.com/scttcper/koa-simple-ratelimit
koa koa2 rate-limits
Last synced: 4 months ago
JSON representation
Simple rate limiter for Koa.js v2 web framework
- Host: GitHub
- URL: https://github.com/scttcper/koa-simple-ratelimit
- Owner: scttcper
- License: mit
- Created: 2015-12-03T22:10:19.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-02T03:41:10.000Z (over 3 years ago)
- Last Synced: 2024-09-30T21:05:35.553Z (4 months ago)
- Topics: koa, koa2, rate-limits
- Language: TypeScript
- Homepage:
- Size: 1.27 MB
- Stars: 17
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-simple-ratelimit
[![NPM version][npm-img]][npm-url]
[](https://circleci.com/gh/scttcper/ts-trueskill)
[![coverage][coverage-img]][coverage-url]
[npm-img]: https://img.shields.io/npm/v/koa-simple-ratelimit.svg
[npm-url]: https://npmjs.org/package/koa-simple-ratelimit
[coverage-img]: https://codecov.io/gh/scttcper/koa-simple-ratelimit/branch/master/graph/badge.svg
[coverage-url]: https://codecov.io/gh/scttcper/koa-simple-ratelimit
Rate limiter middleware for koa v2. Differs from [koa-ratelimit](https://github.com/koajs/ratelimit) by not depending on [ratelimiter](https://github.com/tj/node-ratelimiter) and using redis ttl (time to live) to handle expiration time remaining. This creates only one entry in redis instead of the three that node-ratelimiter does.
## Installation
```sh
npm install koa-simple-ratelimit
```
## Example
```ts
import Koa from 'koa';
import redis from 'redis';
import { ratelimit } from 'koa-simple-ratelimit';
const app = new Koa();
// Apply rate limit
app.use(ratelimit({
db: redis.createClient(),
duration: 60000,
max: 100
}));
// Response middleware
app.use((ctx, next) => {
ctx.body = 'Stuff!';
return next();
});
app.listen(4000);
console.log('listening on port http://localhost:4000');
```
## Options
- `db` redis connection instance
- `max` max requests within `duration` [2500]
- `duration` of limit in milliseconds [3600000]
- `id` id to compare requests [ip]
- `allowlist` array of ids to allowlist
- `blocklist` array of ids to blocklist
- `prefix` redis key prefix ["limit"]
## Responses
Example 200 with header fields:
```
HTTP/1.1 200 OK
X-Powered-By: koa
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1384377793
Content-Type: text/plain; charset=utf-8
Content-Length: 6
Date: Wed, 13 Nov 2013 21:22:13 GMT
Connection: keep-alive
Stuff!
```
Example 429 response:
```
HTTP/1.1 429 Too Many Requests
X-Powered-By: koa
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1384377716
Content-Type: text/plain; charset=utf-8
Content-Length: 39
Retry-After: 7
Date: Wed, 13 Nov 2013 21:21:48 GMT
Connection: keep-alive
Rate limit exceeded, retry in 8 seconds
```
## License
MIT