Class TimedMap<K, T>

Represents a map with timed entries. Entries in the map have an optional expiration time and can be automatically cleaned up.

Type Parameters

K
The type of the keys in the map.
T
The type of the values in the map.

Index

Constructors

Properties

lastCleanup map options

Accessors

Methods

cleanup clear delete entries get keys set shouldCheckExpired values

Constructors

constructor

new TimedMap<K, T>(options: TimedMapOptions): TimedMap<K, T>
Type Parameters
- K
- T
Parameters
- options: TimedMapOptions
Returns TimedMap<K, T>
- Defined in packages/util/src/timedMap.ts:23

Properties

`Private`lastCleanup

lastCleanup: number = 0

`Private` `Readonly`map

map: Map<K, { created: number; lastAccess?: number; value: T }> = ...

`Private` `Readonly`options

options: TimedMapOptions

Accessors

size

get size(): number
Gets the number of key-value pairs in the TimedMap.

Returns number
The number of key-value pairs in the TimedMap.
- Defined in packages/util/src/timedMap.ts:30

Methods

cleanup

cleanup(): void
Performs cleanup if necessary of expired entries and entries exceeding the limit.

Returns void
- Defined in packages/util/src/timedMap.ts:87

clear

clear(): void
Clears all entries from the map.

Returns void
- Defined in packages/util/src/timedMap.ts:115

delete

delete(key: K): boolean
Deletes the entry with the specified key from the map.
Parameters
- key: K
  The key of the entry to delete.
Returns boolean
true if the entry was successfully deleted, false otherwise.
- Defined in packages/util/src/timedMap.ts:75

entries

entries(): IterableIterator<[K, T]>
Returns an iterable iterator that contains the entries of the timed map. Each entry is a key-value pair, represented as an array [key, value]. If the entries have expired based on the time-to-live (ttl) option, they are skipped.

Returns IterableIterator<[K, T]>
An iterable iterator of key-value pairs.
- Defined in packages/util/src/timedMap.ts:145

get

get(key: K): undefined | T
Retrieves the value associated with the specified key from the timed map.
Parameters
- key: K
  The key to retrieve the value for.
Returns undefined | T
The value associated with the key, or undefined if the key does not exist.
- Defined in packages/util/src/timedMap.ts:39

keys

keys(): IterableIterator<K>
Returns an iterable iterator of the keys in the TimedMap.

Returns IterableIterator<K>
An iterable iterator of the keys.
- Defined in packages/util/src/timedMap.ts:123

set

set(key: K, value: T): this
Sets a key-value pair in the map. If the key already exists, updates the value and updates the last access timestamp. If the key does not exist, adds a new entry with the specified key, value, and creation timestamp. Performs cleanup if necessary.
Parameters
- key: K
  The key to set.
- value: T
  The value to set.
Returns this
The updated TimedMap instance.
- Defined in packages/util/src/timedMap.ts:57

`Private`shouldCheckExpired

shouldCheckExpired(): undefined | boolean | 0
Checks if the expiration time for the map entries has been reached.

Returns undefined | boolean | 0
True if the expiration time has been reached, false otherwise.
- Defined in packages/util/src/timedMap.ts:170

values

values(): IterableIterator<T>
Returns an iterable iterator of the values in the TimedMap.

Returns IterableIterator<T>
An iterable iterator of the values.
- Defined in packages/util/src/timedMap.ts:133