Class MemoryMapCacheWithAutomaticCalculation<Records>

Cache implementation that uses a Map to store the data. The values are calculated automatically if not present in the cache.

Type Parameters

Records extends Record<string, Some | null> = Record<string, Some | null>

Hierarchy

MemoryMapCache<Records>
- MemoryMapCacheWithAutomaticCalculation

Implements

Interfaces.IterableCache<Records, true>

Index

Constructors

constructor

new MemoryMapCacheWithAutomaticCalculation<Records>(calculators): MemoryMapCacheWithAutomaticCalculation<Records>
Type Parameters
- Records extends Record<string, null | Some> = Record<string, null | Some>
Parameters
- calculators: {
  [Key in string | number | symbol]: (() => Records[Key])
  }
Returns MemoryMapCacheWithAutomaticCalculation<Records>
Overrides MemoryMapCache.constructor
- Defined in src/helpers/cache/memoryMapCache.ts:39

Properties

`Protected` `Readonly` cache

cache: Map<keyof Records, Records[keyof Records]> = ...

`Private` `Readonly` calculators

calculators: {
[Key in string | number | symbol]: (() => Records[Key])
}

Methods

[iterator]

[iterator](): IterableIterator<[keyof Records, Records[keyof Records]]>
Iterates over all the records in the cache.

Returns IterableIterator<[keyof Records, Records[keyof Records]]>
Implementation of IterableCache.[iterator]

Overrides MemoryMapCache.[iterator]
- Defined in src/helpers/cache/memoryMapCache.ts:54

clearAll

clearAll(): void
Clears all the values from the cache.

Returns void
Implementation of IterableCache.clearAll

Inherited from MemoryMapCache.clearAll
- Defined in src/helpers/cache/memoryMapCache.ts:18

clearValue

clearValue<Key>(key): void
Clears a value from the cache.
Type Parameters
- Key extends string | number | symbol
  
  The type of the record key.
Parameters
- key: Key
  
  The record key.
Returns void
Implementation of IterableCache.clearValue

Inherited from MemoryMapCache.clearValue
- Defined in src/helpers/cache/memoryMapCache.ts:22

hasValue

hasValue<Key>(key): boolean
Checks whether the cache has a value for the specified key.
Type Parameters
- Key extends string | number | symbol
  
  The type of the record key.
Parameters
- key: Key
  
  The record key.
Returns boolean
Whether the cache has a value for the specified key.
Implementation of IterableCache.hasValue

Inherited from MemoryMapCache.hasValue
- Defined in src/helpers/cache/memoryMapCache.ts:26

readValue

readValue<Key>(key): Records[Key]
Reads a value from the cache.
Type Parameters
- Key extends string | number | symbol
  
  The type of the record key.
Parameters
- key: Key
  
  The record key.
Returns Records[Key]
The record value or undefined if the record does not exist.
Implementation of IterableCache.readValue

Overrides MemoryMapCache.readValue
- Defined in src/helpers/cache/memoryMapCache.ts:43

saveValue

saveValue<Key>(key, value): void
Saves a value to the cache.
Type Parameters
- Key extends string | number | symbol
  
  The type of the record key.
Parameters
- key: Key
  
  The record key.
- value: Records[Key]
  
  The record value.
Returns void
Implementation of IterableCache.saveValue

Inherited from MemoryMapCache.saveValue
- Defined in src/helpers/cache/memoryMapCache.ts:10

Class MemoryMapCacheWithAutomaticCalculation<Records>

Type Parameters

Records extends Record<string, Some | null> = Record<string, Some | null>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Records extends Record<string, null | Some> = Record<string, null | Some>

Parameters

calculators: { [Key in string | number | symbol]: (() => Records[Key])}

Returns MemoryMapCacheWithAutomaticCalculation<Records>

Properties

Protected Readonly cache

Private Readonly calculators

Methods

[iterator]

Returns IterableIterator<[keyof Records, Records[keyof Records]]>

clearAll

Returns void

clearValue

Type Parameters

Key extends string | number | symbol

Parameters

key: Key

Returns void

hasValue

Type Parameters

Key extends string | number | symbol

Parameters

key: Key

Returns boolean

readValue

Type Parameters

Key extends string | number | symbol

Parameters

key: Key

Returns Records[Key]

saveValue

Type Parameters

Key extends string | number | symbol

Parameters

key: Key

value: Records[Key]

Returns void

Settings

Member Visibility

Theme

On This Page

calculators: {
[Key in string | number | symbol]: (() => Records[Key])
}

`Protected` `Readonly` cache

`Private` `Readonly` calculators