@sapphire/ratelimits

@sapphire/ratelimits

Bucket implementation for Ratelimits.

Table of Contents

• Description
• Features
• Installation
• Usage
  • Token Bucket
  • Leaky Bucket
• API Documentation
• Buy us some doughnuts
• Contributors ✨

Description

There is often a need to apply ratelimits to protect a network from excessive traffic levels on connections routed through it. This package offers two different techniques in the same implementation: the simple Token Bucket, and the more complex Leaky Bucket.

Features

• Written in TypeScript
• Bundled with Rollup so it can be used in NodeJS and browsers
• Offers CommonJS, ESM and UMD bundles
• Fully tested

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/ratelimits

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { Bucket } = require('@sapphire/ratelimits') equals import { Bucket } from '@sapphire/ratelimits'.

Token Bucket

// Import the Bucket class
const { Bucket } = require('@sapphire/ratelimits');

// Define a bucket with 1 usage every 5 seconds
const bucket = new Bucket().setDelay(5000);

console.log(bucket.take(420)); // -> 0
console.log(bucket.take(420)); // -> 5000

Leaky Bucket

// Import the Bucket class
const { Bucket } = require('@sapphire/ratelimits');

// Define a bucket with 2 usages every 5 seconds
const bucket = new Bucket().setLimit({ timespan: 5000, maximum: 2 });

console.log(bucket.take(420)); // -> 0
console.log(bucket.take(420)); // -> 0
console.log(bucket.take(420)); // -> 5000

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
Open Collective	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeroen Claassens 💻 🚇 📆 📖 ⚠️	Antonio Román 💻 📆 👀 ⚠️	Gryffon Bellish 💻 👀 ⚠️	Vlad Frangu 💻 🐛 👀 📓 ⚠️	Soumil07 💻 📆 ⚠️	depfu[bot] 🚧	allcontributors[bot] 📖
Tyler J Russell 📖	Ivan Lieder 💻 🐛	Hezekiah Hendry 💻	Stitch07 💻 ⚠️	Vetlix 💻	Ethan Mitchell 📖	Elliot 💻
Jurien Hamaker 💻	Charalampos Fanoulis 📖	dependabot[bot] 🚧	Kaname 💻	nandhagk 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!