Class LRUCacheProvider<K, V>

LRU Cache Provider

Since

5.16.0

Type Parameters

K = any
V = any

Hierarchy

LRUMap
- LRUCacheProvider

Implements

CacheProvider<K, V>

Index

Constructors

constructor

new LRUCacheProvider<K, V>(config): 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, V>(maxEntry?): LRUCacheProvider<K, V>
Type Parameters
- K = any
- V = any
Parameters
- Optional maxEntry: number
  Optional
Returns LRUCacheProvider<K, V>
Overrides LRUMap.constructor
- Defined in build/repo/src/cacheProvider.ts:114

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Protected` `Readonly` _cachePolicy

_cachePolicy: CachePolicy = DEFAULT_CACHE_POLICY

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

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

Returns IterableIterator<[any, any]>
Implementation of CacheProvider.[iterator]

Inherited from LRUMap.[iterator]
- Defined in buildhome/.nvm/versions/node/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

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): 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/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:25

entries

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

Returns IterableIterator<[any, any]>
Implementation of CacheProvider.entries

Inherited from LRUMap.entries
- Defined in buildhome/.nvm/versions/node/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      
      value: any
      
      key: any
      
      map: Map<any, any>
      
      Returns void
- Optional thisArg: any
  Optional
Returns void
Implementation of CacheProvider.forEach

Inherited from LRUMap.forEach
- Defined in buildhome/.nvm/versions/node/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key): 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, 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:122

has

has(key): 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/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

keys

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

Returns IterableIterator<any>
Implementation of CacheProvider.keys

Inherited from LRUMap.keys
- Defined in buildhome/.nvm/versions/node/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

set

set(key, val): LRUCacheProvider<K, V>
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 LRUCacheProvider<K, V>
Implementation of CacheProvider.set

Inherited from LRUMap.set
- Defined in build/repo/src/functional/LRUMap.ts:53

setMaxSize

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

values

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

Returns IterableIterator<any>
Implementation of CacheProvider.values

Inherited from LRUMap.values
- Defined in buildhome/.nvm/versions/node/v14.21.3/lib/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class LRUCacheProvider<K, V>

Since

Type Parameters

K = any

V = any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

K = any

V = any

Parameters

config: CacheConfig<LRUCacheProviderParam>

Returns LRUCacheProvider<K, V>

Type Parameters

K = any

V = any

Parameters

Optional maxEntry: number

Returns LRUCacheProvider<K, V>

Properties

Readonly [toStringTag]

Protected Readonly _cachePolicy

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[any, any]>

clear

Returns void

delete

Parameters

key: any

Returns boolean

entries

Returns IterableIterator<[any, any]>

forEach

Parameters

callbackfn: ((value, key, map) => void)

Parameters

value: any

key: any

map: Map<any, any>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: any

Returns any

getMaxSize

Returns number

getOrCreate

Type Parameters

R

Parameters

key: K

producer: GeneralFunction<any[], R>

Returns R

has

Parameters

key: any

Returns boolean

keys

Returns IterableIterator<any>

set

Parameters

key: any

val: any

Returns LRUCacheProvider<K, V>

setMaxSize

Parameters

maxSize: number

Returns void

`Optional` maxEntry: number

`Readonly` [toStringTag]

`Protected` `Readonly` _cachePolicy

`Readonly` size

`Static` `Readonly` [species]

`Optional` thisArg: any