symfony/rate-limiter

Provides a Token Bucket implementation to rate limit input and output in your application

Maintainers

Details

github.com/symfony/rate-limiter

Homepage

Source

Fund package maintenance!
fabpot
Tidelift
symfony.com/sponsor

Installs: 78 528

Dependents: 10

Suggesters: 0

Security: 0

Stars: 71

Watchers: 6

Forks: 2

v5.3.0-BETA1 2021-04-01 10:43 UTC

Requires

Requires (Dev)

MIT f2fee58d9271dea116a392f5232f023410c0c52f

limiterrate-limiter

This package is auto-updated.

Last update: 2021-04-18 06:44:13 UTC

README

The Rate Limiter component provides a Token Bucket implementation to rate limit input and output in your application.

This Component is experimental. Experimental features are not covered by Symfony's Backward Compatibility Promise.

Getting Started

$ composer require symfony/rate-limiter

use Symfony\Component\RateLimiter\Storage\InMemoryStorage;
use Symfony\Component\RateLimiter\RateLimiterFactory;

$factory = new RateLimiterFactory([
    'id' => 'login',
    'policy' => 'token_bucket',
    'limit' => 10,
    'rate' => ['interval' => '15 minutes'],
], new InMemoryStorage());

$limiter = $factory->create();

// blocks until 1 token is free to use for this process
$limiter->reserve(1)->wait();
// ... execute the code

// only claims 1 token if it's free at this moment (useful if you plan to skip this process)
if ($limiter->consume(1)->isAccepted()) {
   // ... execute the code
}

Resources