Class TTLCacheProvider<K, V>

TTL Cache Provider

Since

5.16.0

Type Parameters

K = any
V = any

Hierarchy (view full)

TTLMap<K, V>
- TTLCacheProvider

Implements

CacheProvider<K, V>

Index

Constructors

constructor

new TTLCacheProvider<K, V>(config): TTLCacheProvider<K, V>
Type Parameters
- K = any
- V = any
Parameters
- config: CacheConfig<TTLCacheProviderParam>
Returns TTLCacheProvider<K, V>
Overrides TTLMap.constructor
- Defined in build/repo/src/cacheProvider.ts:151
new TTLCacheProvider<K, V>(ttl?, checkInterval?, maxEntry?): TTLCacheProvider<K, V>
Type Parameters
- K = any
- V = any
Parameters
- Optionalttl: number
- OptionalcheckInterval: number
- OptionalmaxEntry: number
Returns TTLCacheProvider<K, V>
Overrides TTLMap<K, V>.constructor
- Defined in build/repo/src/cacheProvider.ts:152

Properties

`Protected` `Readonly`_cachePolicy

_cachePolicy: CachePolicy

`Readonly`[toStringTag]

[toStringTag]: string

`Static` `Readonly`[species]

[species]: MapConstructor

Accessors

size

get size(): number
Returns number
the number of elements in the Map.
Implementation of CacheProvider.size
Inherited from TTLMap.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]>
Implementation of CacheProvider.[iterator]
Inherited from TTLMap.[iterator]
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

cleanTimeoutItems

cleanTimeoutItems(): void
manually directly clean all timeout items

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

clear

clear(): void
Returns void
Implementation of CacheProvider.clear
Inherited from TTLMap.clear
- Defined in build/repo/src/functional/TTLMap.ts:109

delete

delete(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.
Implementation of CacheProvider.delete
Inherited from TTLMap.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]>
Implementation of CacheProvider.entries
Inherited from TTLMap.entries
- Defined in build/repo/src/functional/TTLMap.ts:144

forEach

forEach(callbackfn, thisArg?): 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)
  - - (value, key, map): void
    - Parameters
      value: V
      key: K
      map: Map<K, V>
      Returns void
- OptionalthisArg: any
Returns void
Implementation of CacheProvider.forEach
Inherited from TTLMap.forEach
- Defined in build/repo/src/functional/TTLMap.ts:159

get

get(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.
Implementation of CacheProvider.get
Inherited from TTLMap.get
- Defined in build/repo/src/functional/TTLMap.ts:88

getOrCreate

getOrCreate<R>(key, producer): R
get cache or create it on necessary
Type Parameters
- R
Parameters
- key: K
- producer: GeneralFunction<any[], R>
Returns R
Implementation of CacheProvider.getOrCreate
- Defined in build/repo/src/cacheProvider.ts:169

has

has(k): boolean
Parameters
- k: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of CacheProvider.has
Inherited from TTLMap.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>
Implementation of CacheProvider.keys
Inherited from TTLMap.keys
- Defined in build/repo/src/functional/TTLMap.ts:149

set

set(k, v, ttl?): TTLCacheProvider<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 TTLCacheProvider<K, V>
Implementation of CacheProvider.set
Inherited from TTLMap.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>
Implementation of CacheProvider.values
Inherited from TTLMap.values
- Defined in build/repo/src/functional/TTLMap.ts:154

Class TTLCacheProvider<K, V>

Since

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TTLCacheProvider<K, V>

Type Parameters

Parameters

Returns TTLCacheProvider<K, V>

Properties

Protected Readonly_cachePolicy

Readonly[toStringTag]

Static Readonly[species]

Accessors

size

Returns number

Methods

[iterator]

Returns MapIterator<[K, V]>

cleanTimeoutItems

Returns void

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[K, V]>

forEach

Parameters

Parameters

Returns void

Returns void

get

Parameters

Returns V

getOrCreate

Type Parameters

Parameters

Returns R

has

Parameters

Returns boolean

keys

Returns MapIterator<K>

set

Parameters

Returns TTLCacheProvider<K, V>

values

Returns MapIterator<V>

Settings

On This Page

`Protected` `Readonly`_cachePolicy

`Readonly`[toStringTag]

`Static` `Readonly`[species]