Type Alias RateLimitBucketOptions<T>

Configuration options for rate limiting behavior when using an existing bucket.

type RateLimitBucketOptions<T extends Func> = {
    bucket: RateLimitTokenBucket;
    onLimitReached?: (
        error: RateLimitError,
        nextAvailable: Date,
        args: Parameters<T>,
    ) => void | Promise<void>;
    throws?: boolean;
}

Type Parameters

T extends Func
The function type being rate limited

Index

Properties

bucket onLimitReached? throws?

Properties

bucket

bucket: RateLimitTokenBucket

An existing RateLimitTokenBucket instance to use

`Optional`onLimitReached

onLimitReached?: (
    error: RateLimitError,
    nextAvailable: Date,
    args: Parameters<T>,
) => void | Promise<void>

Callback invoked when rate limit is exceeded

`Optional`throws

throws?: boolean

Whether to throw an error when limit is exceeded (default: true)