Class Cache<K, T>

constructor

• new Cache<K, T>(key?, options?): Cache<K, T>

• Create new cache

  Type Parameters

  • K extends string | number | symbol
  • T

  Parameters

  • Optionalkey: keyof T

    Default property to use as primary key
  • options: CacheOptions = {}

  Returns Cache<K, T>

complete

Optional Readonlykey

loading

Readonlyoptions

values

add

• add(value, ttl?): this

• Add a new item to the cache. Like set, but finds key automatically

  Parameters

  • value: T

    Item to add to cache
  • ttl: any = ...

    Override default expiry

  Returns this

addAll

• addAll(rows, complete?): this

• Add several rows to the cache

  Parameters

  • rows: T[]

    Several items that will be cached using the default key
  • complete: boolean = true

    Mark cache as complete & reliable, defaults to true

  Returns this

all

• all(expired?): CachedValue<T>[]

• Get all cached items

  Parameters

  • Optionalexpired: boolean

  Returns CachedValue<T>[]

  Array of items

clear

• clear(): this

• Remove all keys from cache

  Returns this

delete

• delete(key): this

• Delete an item from the cache

  Parameters

  • key: K

    Item's primary key

  Returns this

entries

• entries(expired?): [K, CachedValue<T>][]

• Return cache as an array of key-value pairs

  Parameters

  • Optionalexpired: boolean

  Returns [K, CachedValue<T>][]

  Key-value pairs array

expire

• expire(key): this

• Manually expire a cached item

  Parameters

  • key: K

    Key to expire

  Returns this

find

• find(filter, expired?): undefined | T

• Find the first cached item to match a filter

  Parameters

  • filter: Partial<T>

    Partial item to match
  • Optionalexpired: boolean

    Include expired items, defaults to false

  Returns undefined | T

  Cached item or undefined if nothing matched

get

• get(key, expired?): null | CachedValue<T>

• Get item from the cache

  Parameters

  • key: K

    Key to lookup
  • Optionalexpired: boolean

    Include expired items

  Returns null | CachedValue<T>

  Cached item

keys

• keys(expired?): K[]

• Get a list of cached keys

  Parameters

  • Optionalexpired: boolean

  Returns K[]

  Array of keys

map

• map(expired?): Record<K, CachedValue<T>>

• Get map of cached items

  Parameters

  • Optionalexpired: boolean

  Returns Record<K, CachedValue<T>>

set

• set(key, value, ttl?): this

• Add an item to the cache manually specifying the key

  Parameters

  • key: K

    Key item will be cached under
  • value: T

    Item to cache
  • ttl: undefined | number = ...

    Override default expiry in seconds

  Returns this