Class TtlCache<T, P>

constructor

• new TtlCache<T, P extends any[]>(
      load: CacheLoader<T, P>,
      options?: Partial<TtlCacheOptions<P>>,
  ): TtlCache<T, P>

  Type Parameters

  • T
  • P extends any[]

  Parameters

  • load: CacheLoader<T, P>

    function that loads the underlying values. It gets passed the same parameters as get. The load function may be synchronous or asynchronous (i.e. returning a promise).
  • Optionaloptions: Partial<TtlCacheOptions<P>>

    optional, see TtlCache.OPTIONS

  Returns TtlCache<T, P>

StaticOPTIONS

get

• get(...params: P): Promise<T>

  Returns the value associated with the given parameters if available and not expired, or calls the load function to generate it.

  Parameters

  • ...params: P

    parameters for the load function.

  Returns Promise<T>

getCached

• getCached(...params: P): undefined | T

  Returns any value currently associated with the given parameters, even if expired.

  Parameters

  • ...params: P

    parameters for the load function.

  Returns undefined | T

clear

• clear(): void

  Discards all stored values.

  Returns void