Directus / @directus/memory / index / LimiterRedis

Class: LimiterRedis ​

Implements ​

• Limiter

Constructors ​

new LimiterRedis(config) ​

new LimiterRedis(config): LimiterRedis

Parameters ​

• config: Omit<LimiterConfigRedis, "type">

Returns ​

LimiterRedis

Source ​

packages/memory/src/limiter/lib/redis.ts:10

Properties ​

limiter ​

private limiter: RateLimiterRedis

Source ​

packages/memory/src/limiter/lib/redis.ts:7

points ​

private points: number

Source ​

packages/memory/src/limiter/lib/redis.ts:8

Methods ​

consume() ​

consume(key): Promise<void>

Consume a point for the given key

Parameters ​

• key: string

IP address, URL path, or any other string

Returns ​

Promise<void>

Implementation of ​

Limiter.consume

Source ​

packages/memory/src/limiter/lib/redis.ts:21

delete() ​

delete(key): Promise<void>

Delete the tracked information for a given key

Parameters ​

• key: string

IP address, URL path, or any other string

Returns ​

Promise<void>

Implementation of ​

Limiter.delete

Source ​

packages/memory/src/limiter/lib/redis.ts:25