Class TTLMap<K, V>

TTL (Time to Life) Map

it will lazy remove values when perform operations

Since

5.18.0

Type Parameters

K = any
V = any

Hierarchy (View Summary)

Map<K, V>
- TTLMap
  - TTLCacheProvider

Index

Constructors

Properties

[toStringTag] [species]

Accessors

Methods

[iterator] cleanTimeoutItems clear delete entries forEach get has keys set values

Constructors

constructor

new TTLMap<K = any, V = any>(
defaultTTL?: number,
cleanAfterOperation?: number,
): TTLMap<K, V>
TTLMap (Time to Life) Map

it will lazy remove values when perform operations
Type Parameters
- K = any
- V = any
Parameters
- defaultTTL: number = ...
  time to live, in milliseconds, default value is 60 seconds
- cleanAfterOperation: number = 100
  execute full clean after operations. default value is 100, it means, at least 100 operations performed, the TTL evict logic will be executed
Returns TTLMap<K, V>
Overrides Map<K, V>.constructor
- Defined in build/repo/src/functional/TTLMap.ts:21

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

size

get size(): number
Returns number
the number of elements in the Map.
Overrides Map.size
- Defined in build/repo/src/functional/TTLMap.ts:164

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns an iterable of entries in the map.

Returns MapIterator<[K, V]>
Inherited from Map.[iterator]
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

cleanTimeoutItems

cleanTimeoutItems(): void
manually directly clean all timeout items

Returns void
- Defined in build/repo/src/functional/TTLMap.ts:139

clear

clear(): void
Returns void
Overrides Map.clear
- Defined in build/repo/src/functional/TTLMap.ts:109

delete

delete(k: K): boolean
Parameters
- k: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Overrides Map.delete
- Defined in build/repo/src/functional/TTLMap.ts:102

entries

entries(): MapIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[K, V]>
Overrides Map.entries
- Defined in build/repo/src/functional/TTLMap.ts:144

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
- OptionalthisArg: any
Returns void
Overrides Map.forEach
- Defined in build/repo/src/functional/TTLMap.ts:159

get

get(k: K): V
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- k: K
Returns V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Overrides Map.get
- Defined in build/repo/src/functional/TTLMap.ts:88

has

has(k: K): boolean
Parameters
- k: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Overrides Map.has
- Defined in build/repo/src/functional/TTLMap.ts:74

keys

keys(): MapIterator<K>
Returns an iterable of keys in the map

Returns MapIterator<K>
Overrides Map.keys
- Defined in build/repo/src/functional/TTLMap.ts:149

set

set(k: K, v: V, ttl?: number): TTLMap<K, V>
set value
Parameters
- k: K
  key
- v: V
  value
- ttl: number = ...
  time to live, in milliseconds, if undefined, will use instance level defaultTTL
Returns TTLMap<K, V>
Overrides Map.set
- Defined in build/repo/src/functional/TTLMap.ts:66

values

values(): MapIterator<V>
Returns an iterable of values in the map

Returns MapIterator<V>
Overrides Map.values
- Defined in build/repo/src/functional/TTLMap.ts:154