# rate_limiter

**Repository Path**: src-upstream-repos/rate_limiter

## Basic Information

- **Project Name**: rate_limiter
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-27
- **Last Updated**: 2024-01-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rate_limiter

A utility class for rate limiting, ported from @meew0's implementation in [discordrb](https://github.com/meew0/discordrb/blob/master/lib/discordrb/commands/rate_limiter.rb)

## Installation

Add this to your application's `shard.yml`:

```yaml
dependencies:
  rate_limiter:
    github: z64/rate_limiter
```

## Usage

```crystal
require "rate_limiter"

# Make a new rate limiter that will limit based on string "usernames"
limiter = RateLimiter(String).new

# Create a bucket that allows 3 requests per second
limiter.bucket(:foo, 3_u32, 1.seconds)

# Perform a request on "z64"
limiter.rate_limited?(:foo, "z64")
```

## Contributors

- [z64](https://github.com/z64) Zac Nowicki - creator, maintainer