Class MemoryCache

constructor

• new MemoryCache(cache?): MemoryCache

• Create a memory cache.

  Parameters

  • Optional cache: CacheEngine

    The cache engine to use.

  Returns MemoryCache

_mc

_subscribedPaths

_subscribers

set

keys

• get keys(): string[]

• Returns string[]

memsize

• get memsize(): undefined | number

• Returns undefined | number

size

• get size(): number

• Returns number

clear

• clear(): void

• Clear the cache. This method will also notify all subscribers about the cache being cleared.

  Returns void

del

• del(key, ...args): void

• Delete a value from the cache. This method will also notify all subscribers about the deletion.

  Parameters

  • key: Path

    The key of the item to delete.
  • Rest ...args: any[]

    Additional arguments.

  Returns void

  See

  • Path
  • https://www.npmjs.com/package/object-path|object-path

get

• get<T>(key?, defaultValue?): any

• Get a value from the cache. If no key is provided, it returns an object with all key-value pairs in the cache. If a key is provided, it returns the value for that key, or the default value if the key is not in the cache.

  Type Parameters

  • T = any

  Parameters

  • Optional key: Path

    The key of the item to get.
  • Optional defaultValue: T

    The default value to return if the key is not in the cache.

  Returns any

  The value of the item, or an object with all key-value pairs in the cache.

  See

  • Path
  • https://www.npmjs.com/package/object-path|object-path

getValue

• getValue(key): any

• Get a value from the cache.

  Parameters

  • key: Path

    The key of the item to get.

  Returns any

  The value of the item.

  See

  • Path
  • https://www.npmjs.com/package/object-path|object-path

keySubscribers

• keySubscribers(key): CacheEventHandler[]

• Parameters

  • key: Path

  Returns CacheEventHandler[]

merge

• merge(values?, options?): any

• Merge values into the cache. This method will also notify all subscribers about the merge operation.

  Parameters

  • Optional values: ImportData = {}

    The values to merge into the cache.
  • Optional options: {
        skipDuplicates: boolean;
    } = ...

    The options for the merge operation.

    • skipDuplicates: boolean

      Whether to skip duplicate keys.

  Returns any

put

• put<T>(key?, value, time?, timeoutCallback?): void

• Get a value from the cache. If no key is provided, it returns an object with all key-value pairs in the cache. If a key is provided, it returns the value for that key, or the default value if the key is not in the cache.

  Type Parameters

  • T = any

  Parameters

  • Optional key: Path

    The key of the item to get.
  • value: T
  • Optional time: number
  • Optional timeoutCallback: TimeoutCallback

  Returns void

  The value of the item, or an object with all key-value pairs in the cache.

  See

  • Path
  • https://www.npmjs.com/package/object-path|object-path

subscribe

• subscribe(key, cb): (() => void)

• Subscribe to changes to a cache item.

  Parameters

  • key: Path

    The key of the item to subscribe to.
  • cb: CacheEventHandler

    The function to call when the item changes.

  Returns (() => void)

  The function to call to unsubscribe.

  • • (): void

    • Returns void

  See

  • Path
  • https://www.npmjs.com/package/object-path|object-path

Static denormalizeKey

• denormalizeKey(keyString): string[]

• Parameters

  • keyString: Path

  Returns string[]

Static getKeyRoot

• getKeyRoot(key): string

• Parameters

  • key: Path

  Returns string

Static normalizeKey

• normalizeKey(key): string | number

• Parameters

  • key: Path

  Returns string | number

Static sanitizeKey

• sanitizeKey(key): string

• Parameters

  • key: Path

  Returns string