Nine Post Meridiem

    @sapphire/ratelimits
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.5 • Public • Published

    Sapphire Logo

    @sapphire/ratelimits

    Bucket implementation for Ratelimits.

    GitHub codecov npm bundle size npm

    Table of Contents

    Description

    There is often a need to apply ratelimits to protect a network from excessive traffic levels on connections routed through it, or limit bot command usages in your Discord bot, or similar things. This package offers two different techniques in the same implementation: the Token Bucket, and the Leaky Bucket.

    Features

    • Written in TypeScript
    • Bundled with esbuild 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 { RateLimitManager } = require('@sapphire/ratelimits') equals import { RateLimitManager } from '@sapphire/ratelimits'.

    Token RateLimitManager

    // Import the Bucket class
    const { RateLimitManager } = require('@sapphire/ratelimits');
    
    // Define a bucket with 1 usage every 5 seconds
    const rateLimitManager = new RateLimitManager(5000);
    
    // Acquire the rate limit. The ID can be something like `'global'`, a Discord channel/server/user ID, or anything else.
    const ratelimit = rateLimitManager.acquire('some-unique-id-here');
    
    // Check if there is a rate limit right now
    if (ratelimit.limited) {
    	// Do something when limited, such as throwing an error
    }
    
    // We're not rate limited so we drip the bucket. After consuming once, the second run through we'll be rate limited.
    ratelimit.consume();
    
    // And now we can finish the flow by returning some form of "success" state.

    Leaky RateLimitManager

    // Import the Bucket class
    const { RateLimitManager } = require('@sapphire/ratelimits');
    
    // Define a bucket with 2 usages every 5 seconds
    const rateLimitManager = new RateLimitManager(5000, 2);
    
    // Acquire the rate limit. The ID can be something like `'global'`, a Discord channel/server/user ID, or anything else.
    const ratelimit = rateLimitManager.acquire('some-unique-id-here');
    
    // Check if there is a rate limit right now
    if (ratelimit.limited) {
    	// Do something when limited, such as throwing an error
    }
    
    // We're not rate limited so we drip the bucket. After consuming twice, the third run through we'll be rate limited.
    ratelimit.consume();
    
    // And now we can finish the flow by returning some form of "success" state.

    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

    💻 🚇 📆 📖 ⚠️

    Aura Román

    💻 📆 👀 ⚠️

    Gryffon Bellish

    💻 👀 ⚠️

    Vlad Frangu

    💻 🐛 👀 📓 ⚠️

    Stitch07

    💻 📆 ⚠️

    depfu[bot]

    🚧

    allcontributors[bot]

    📖

    Tyler J Russell

    📖

    Ivan Lieder

    💻 🐛

    Hezekiah Hendry

    💻 🔧

    Vetlix

    💻

    Ethan Mitchell

    📖

    Elliot

    💻

    Jurien Hamaker

    💻

    Charalampos Fanoulis

    📖

    dependabot[bot]

    🚧

    Kaname

    💻

    nandhagk

    🐛

    megatank58

    💻

    UndiedGamer

    💻

    Lioness100

    📖 💻

    David

    💻

    renovate[bot]

    🚧

    WhiteSource Renovate

    🚧

    FC

    💻

    Jérémy de Saint Denis

    💻

    MrCube

    💻

    bitomic

    💻

    c43721

    💻

    Commandtechno

    💻

    Aura

    💻

    Jonathan

    💻

    Parbez

    🚧

    Paul Andrew

    📖

    Mzato

    💻 🐛

    Harry Allen

    📖

    Evo

    💻

    Enes Genç

    💻

    muchnameless

    💻

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

    Install

    npm i @sapphire/ratelimits

    DownloadsWeekly Downloads

    3,268

    Version

    2.4.5

    License

    MIT

    Unpacked Size

    69.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • favna
    • kyranet
    • vladfrangu