# @sapphire/ratelimits
**Bucket implementation for Ratelimits.**
[](https://github.com/sapphire-project/utilities/blob/main/LICENSE.md)
[](https://lgtm.com/projects/g/sapphire-project/utilities/alerts/)
[](https://lgtm.com/projects/g/sapphire-project/utilities/context:javascript)
[](https://coveralls.io/github/sapphire-project/utilities?branch=main)
[](https://bundlephobia.com/result?p=@sapphire/ratelimits)
[](https://www.npmjs.com/package/@sapphire/ratelimits)
[](https://depfu.com/github/sapphire-project/utilities?project_id=15195)
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Token Bucket](#token-bucket)
- [Leaky Bucket](#leaky-bucket)
- [API Documentation](#api-documentation)
- [Buy us some doughnuts](#buy-us-some-doughnuts)
- [Contributors β¨](#contributors-%E2%9C%A8)
## 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](https://en.wikipedia.org/wiki/Token_bucket), and the more complex [Leaky Bucket](https://en.wikipedia.org/wiki/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
```sh
yarn add @sapphire/ratelimits
# 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
```ts
// 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
```ts
// 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](https://sapphire-project.github.io/utilities/modules/_sapphire_ratelimits.html).
## Buy us some doughnuts
Sapphire Project 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](https://opencollective.com/sapphire-project) |
| Ko-fi | [Click Here](https://ko-fi.com/sapphireproject) |
| Patreon | [Click Here](https://www.patreon.com/sapphire_project) |
| PayPal | [Click Here](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SP738BQTQQYZY) |
## Contributors β¨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
