IStorageEngine

^{ref / ratelimiter / IStorageEngine}

Defines the contract for a storage engine.

^Source

Methods

get

get(key: string): Promise<TokenBucketState | undefined>;

Retrieves the state for a given key.

^Source

set

set(
  key: string,
  state: TokenBucketState,
  ttl: number,
): Promise<void>;

Sets the state for a given key.

^Source

delete

delete(key: string): Promise<void>;

Deletes the state for a given key.

^Source

increment

increment(key: string, ttl: number): Promise<number>;

Atomically increments a key and sets its expiry on the first increment.

^Source

setPenalty

setPenalty(key: string, ttl: number): Promise<void>;

Sets a key with a simple “true” value.

^Source

checkPenalty

checkPenalty(key: string): Promise<boolean>;

Checks for the existence of a penalty key.

^Source