fromRateLimiterFlexible

fromRateLimiterFlexible(limiter, key): RateLimiterAlgorithm

Defined in: src/adapters.ts:23

A rate-limiter-flexible limiter as a RateLimiterAlgorithm for one key. The window runs on the limiter’s own clock.

const rlf = new RateLimiterRedis({ storeClient: redis, points: 100, duration: 60 });
builder.addStrategy((s) => new RateLimiterStrategy(fromRateLimiterFlexible(rlf, 'api'), { queueTimeout: '1s' }, s));
// per key:
builder.addPartitionedRateLimiter({ partitionKey, limiter: (key, s) => new RateLimiterStrategy(fromRateLimiterFlexible(rlf, key), {}, s) });

Parameters

limiter

RateLimiterFlexibleLike

key

string

Returns

RateLimiterAlgorithm