Class MemoryMapCache<Records>

Cache implementation that uses a Map to store the data.

Type Parameters

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

Hierarchy

MemoryMapCache
- MemoryMapCacheWithAutomaticCalculation

Implements

Interfaces.IterableCache<Records>

Index

Constructors

Properties

Methods

[iterator] clearAll clearValue hasValue readValue saveValue

Constructors

constructor

new MemoryMapCache<Records>(): MemoryMapCache<Records>
Type Parameters
- Records extends Record<string, null | Some> = Record<string, Some>
Returns MemoryMapCache<Records>

Properties

`Protected` `Readonly` cache

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

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]
- Defined in src/helpers/cache/memoryMapCache.ts:30

clearAll

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

Returns void
Implementation of IterableCache.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
- 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
- Defined in src/helpers/cache/memoryMapCache.ts:26

readValue

readValue<Key>(key): undefined | 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 undefined | Records[Key]
The record value or undefined if the record does not exist.
Implementation of IterableCache.readValue
- Defined in src/helpers/cache/memoryMapCache.ts:14

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
- Defined in src/helpers/cache/memoryMapCache.ts:10

Generated using TypeDoc