Class LRUCacheProvider<K, V>

LRU Cache Provider

Since

5.16.0

Type Parameters

K = any
V = any

Hierarchy (View Summary)

LRUMap
- LRUCacheProvider

Implements

CacheProvider<K, V>

Index

Constructors

constructor

new LRUCacheProvider<K = any, V = any>(
config: CacheConfig<LRUCacheProviderParam>,
): LRUCacheProvider<K, V>
Type Parameters
- K = any
- V = any
Parameters
- config: CacheConfig<LRUCacheProviderParam>
Returns LRUCacheProvider<K, V>
Overrides LRUMap.constructor
- Defined in build/repo/src/cacheProvider.ts:113
new LRUCacheProvider<K = any, V = any>(
maxEntry?: number,
): LRUCacheProvider<K, V>
Type Parameters
- K = any
- V = any
Parameters
- OptionalmaxEntry: number
Returns LRUCacheProvider<K, V>
Overrides LRUMap.constructor
- Defined in build/repo/src/cacheProvider.ts:114

Properties

`Protected` `Readonly`_cachePolicy

_cachePolicy: CachePolicy = DEFAULT_CACHE_POLICY

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Methods

[iterator]

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

Returns MapIterator<[any, any]>
Implementation of CacheProvider.[iterator]
Inherited from LRUMap.[iterator]
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

clear

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

delete

delete(key: any): boolean
Parameters
- key: any
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 LRUMap.delete
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

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

Returns MapIterator<[any, any]>
Implementation of CacheProvider.entries
Inherited from LRUMap.entries
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

forEach(
callbackfn: (value: any, key: any, map: Map<any, any>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: any, key: any, map: Map<any, any>) => void
- OptionalthisArg: any
Returns void
Implementation of CacheProvider.forEach
Inherited from LRUMap.forEach
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: any): any
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
- key: any
Returns any
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 LRUMap.get
- Defined in build/repo/src/functional/LRUMap.ts:42

getMaxSize

getMaxSize(): number
Returns number
Inherited from LRUMap.getMaxSize
- Defined in build/repo/src/functional/LRUMap.ts:74

getOrCreate

getOrCreate<R>(key: K, producer: GeneralFunction<any[], R>): 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:122

has

has(key: any): boolean
Parameters
- key: any
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of CacheProvider.has
Inherited from LRUMap.has
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

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

Returns MapIterator<any>
Implementation of CacheProvider.keys
Inherited from LRUMap.keys
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

set

set(key: any, val: any): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: any
- val: any
Returns this
Implementation of CacheProvider.set
Inherited from LRUMap.set
- Defined in build/repo/src/functional/LRUMap.ts:53

setMaxSize

setMaxSize(maxSize: number): void
Parameters
- maxSize: number
Returns void
Inherited from LRUMap.setMaxSize
- Defined in build/repo/src/functional/LRUMap.ts:70

values

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

Returns MapIterator<any>
Implementation of CacheProvider.values
Inherited from LRUMap.values
- Defined in buildhome/.nvm/versions/node/v20.18.1/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

Class LRUCacheProvider<K, V>

Since

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LRUCacheProvider<K, V>

Type Parameters

Parameters

Returns LRUCacheProvider<K, V>

Properties

Protected Readonly_cachePolicy

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns MapIterator<[any, any]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[any, any]>

forEach

Parameters

Returns void

get

Parameters

Returns any

getMaxSize

Returns number

getOrCreate

Type Parameters

Parameters

Returns R

has

Parameters

Returns boolean

keys

Returns MapIterator<any>

set

Parameters

Returns this

setMaxSize

Parameters

Returns void

values

Returns MapIterator<any>

Settings

On This Page

`Protected` `Readonly`_cachePolicy

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]