Skip to content

Allow to define custom bucket size #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mosch wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow to define custom bucket size #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/RateLimiter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export type RateLimiterOpts = {
tokensPerInterval: number;
interval: Interval;
fireImmediately?: boolean;
bucketSize?: number;
};

/**
Expand All @@ -18,16 +19,18 @@ export type RateLimiterOpts = {
* one of the following strings: 'second', 'minute', 'hour', day'.
* @param options.fireImmediately Whether or not the promise will resolve
* immediately when rate limiting is in effect (default is false).
* @param options.bucketSize Maximum number of tokens to hold in the bucket.
* Also known as the burst rate. Defaults to options.tokensPerInterval.
*/
export class RateLimiter {
tokenBucket: TokenBucket;
curIntervalStart: number;
tokensThisInterval: number;
fireImmediately: boolean;

constructor({ tokensPerInterval, interval, fireImmediately }: RateLimiterOpts) {
constructor({ tokensPerInterval, interval, fireImmediately, bucketSize }: RateLimiterOpts) {
this.tokenBucket = new TokenBucket({
bucketSize: tokensPerInterval,
bucketSize: bucketSize ?? tokensPerInterval,
tokensPerInterval,
interval,
});
Expand Down