Interface ITimedSet<T>

A set like object that evicts entries from the set after they have been in there for the set time

interface ITimedSet<T> {
    getTimeRemaining(key: T): number;
    isEmpty(): boolean;
    refresh(key: T): boolean;
}

Type Parameters

T

Implemented by

TimedSet

Index

Methods

getTimeRemaining isEmpty refresh

Methods

getTimeRemaining

getTimeRemaining(key): number
Get the time left until this item is removed from the set
Parameters
- key: T
Returns number
- Defined in packages/utilities/src/guards/Rate Limiter/types/ITimedSet.ts:14

isEmpty

isEmpty(): boolean
checks if this set is empty

Returns boolean
- Defined in packages/utilities/src/guards/Rate Limiter/types/ITimedSet.ts:19

refresh

refresh(key): boolean
Refresh the timeout for this element (resets the timer for the items eviction)
Parameters
- key: T
  Key
Returns boolean
- Defined in packages/utilities/src/guards/Rate Limiter/types/ITimedSet.ts:26