ip-token-bucket

IP based token bucket rate limiter / throttler. Read more about Token Buckets.

Usage

Install the package by typing npm i @d3vision/ip-token-bucket in your project folder.

Setup

1const TokenBucket = require("ip-token-bucket");
2
3const bucket = new TokenBucket({
4  maxBurst: 5, // Maximum burst (bucket size) that is accepted
5  perSecond: 1, // How many tokens will be added every 1s
6});
7
8// Take one token out if 127.0.0.1 ip's bucket
9const hasTokens = bucket.take("127.0.0.1");
10
11if (hasTokens) {
12  console.log("User had atleast one token!");
13} else {
14  console.log("User didn't have tokens left.");
15}