Skip to main content

complexityLeakyBucket

API Docs

Function: complexityLeakyBucket()

complexityLeakyBucket(fastify, key, capacity, refillRate, cost, logger): Promise<boolean>

Defined in: src/utilities/leakyBucket.ts:165

Implements a leaky bucket rate limiter (Token Bucket algorithm).

Parameters​

fastify​

FastifyInstance

The Fastify instance.

key​

string

The key to identify the bucket in Redis.

capacity​

number

The maximum capacity of the bucket.

refillRate​

number

The rate at which tokens are added to the bucket.

cost​

number

The cost in tokens for each request.

logger​

AppLogger

The logger instance.

Returns​

Promise<boolean>

  • A promise that resolves to a boolean indicating if the request is allowed.