Directus / @directus/memory / index / LimiterLocal

Class: LimiterLocal ​

Implements ​

• Limiter

Constructors ​

new LimiterLocal(config) ​

new LimiterLocal(config): LimiterLocal

Parameters ​

• config: Omit<LimiterConfigLocal, "type">

Returns ​

LimiterLocal

Source ​

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

Properties ​

limiter ​

private limiter: RateLimiterMemory

Source ​

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

points ​

private points: number

Source ​

packages/memory/src/limiter/lib/local.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/local.ts:19

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/local.ts:23