Gathering detailed insights and metrics for async-ratelimiter
Gathering detailed insights and metrics for async-ratelimiter
Installations
npm install async-ratelimiterDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>= 8
Node Version
22.16.0
NPM Version
10.9.2
Releases
30
Languages
1
JavaScript
JavaScript (100%)
Developer
microlinkhq
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
332 Stars
171 Commits
23 Forks
2 Watchers
1 Branches
11 Contributors
Updated on Jul 02, 2025
Maintainers
1
Package Meta Information
Latest Version
1.6.1
Package Id
async-ratelimiter@1.6.1
Unpacked Size
12.49 kB
Size
4.71 kB
File Count
6
NPM Version
10.9.2
Node Version
22.16.0
Published on
Jul 02, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Rate limit made simple, easy, async. Based on ratelimiter.
Install
1$ npm install async-ratelimiter --save
Usage
The most straightforward way to use the rate limiter:
1'use strict' 2 3const RateLimiter = require('async-ratelimiter') 4const { getClientIp } = require('request-ip') 5const Redis = require('ioredis') 6 7const rateLimiter = new RateLimiter({ 8 db: new Redis() 9}) 10 11const apiQuota = async (req, res, next) => { 12 const clientIp = getClientIp(req) 13 const limit = await rateLimiter.get({ id: clientIp }) 14 15 if (!res.writableEnded) { 16 res.setHeader('X-Rate-Limit-Limit', limit.total) 17 res.setHeader('X-Rate-Limit-Remaining', Math.max(0, limit.remaining - 1)) 18 res.setHeader('X-Rate-Limit-Reset', limit.reset) 19 } 20 21 return !limit.remaining 22 ? sendFail({ 23 req, 24 res, 25 code: HTTPStatus.TOO_MANY_REQUESTS, 26 message: MESSAGES.RATE_LIMIT_EXCEDEED() 27 }) 28 : next(req, res) 29}
For scenarios where you want to check the limit status before consuming a request, you should to pass { peek: true }:
1const apiQuota = async (req, res, next) => {
2 const clientIp = getClientIp(req)
3
4 // Check rate limit status without consuming a request
5 const status = await rateLimiter.get({ id: clientIp, peek: true })
6
7 if (status.remaining === 0) {
8 return sendFail({
9 req,
10 res,
11 code: HTTPStatus.TOO_MANY_REQUESTS,
12 message: MESSAGES.RATE_LIMIT_EXCEDEED()
13 })
14 }
15
16 // Consume a request
17 const limit = await rateLimiter.get({ id: clientIp })
18
19 if (!res.writableEnded) {
20 res.setHeader('X-Rate-Limit-Limit', limit.total)
21 res.setHeader('X-Rate-Limit-Remaining', limit.remaining)
22 res.setHeader('X-Rate-Limit-Reset', limit.reset)
23 }
24
25 return next(req, res)
26}API
constructor(options)
It creates an rate limiter instance.
options
db
Required
Type: object
The redis connection instance.
max
Type: number
Default: 2500
The maximum number of requests within duration.
duration
Type: number
Default: 3600000
How long keep records of requests in milliseconds.
namespace
Type: string
Default: 'limit'
The prefix used for compound the key.
id
Type: string
The identifier to limit against (typically a user id).
You can pass this value using when you use .get method as well.
.get(options)
Given an id, returns a Promise with the status of the limit with the following structure:
total:maxvalue.remaining: number of calls left in currentdurationwithout decreasing currentget.reset: time since epoch in seconds that the rate limiting period will end (or already ended).
options
id
Type: string
Default: this.id
The identifier to limit against (typically a user id).
max
Type: number
Default: this.max
The maximum number of requests within duration. If provided, it overrides the default max value. This is useful for custom limits that differ between IDs.
duration
Type: number
Default: this.duration
How long keep records of requests in milliseconds. If provided, it overrides the default duration value.
peek
Type: boolean
Default: false
When set to true, returns the current rate limit status without consuming a request. This is useful for checking the current rate limit status before deciding whether to proceed with an operation.
defineCommand
It provides the command definition so you can load it into any ioredis instance:
1const Redis = require('ioredis') 2const redis = new Redis(uri, { 3 scripts: { ...require('async-ratelimiter').defineCommand } 4})
Related
- express-slow-down – Slow down repeated requests; use as an alternative (or addition) to express-rate-limit.
License
async-ratelimiter © microlink.io, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.
microlink.io · GitHub microlink.io · X @microlinkhq
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
17 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
Found 0/27 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/main.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull_request.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/pull_request.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pull_request.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/pull_request.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull_request.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/pull_request.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pull_request.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/pull_request.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pull_request.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/microlinkhq/async-ratelimiter/pull_request.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/pull_request.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dangerous workflow patterns detected
Details
- Warn: script injection with untrusted input ' github.head_ref ': .github/workflows/main.yml:30
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Score
3.1
/10
Last Scanned on 2025-06-30
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