Class ReadThroughCache<K, V, CacheTag, WriteResultAvailable, N>Abstract

Abstract Readonly_writeResultAvailable

Optional ReadonlydefaultTtl

Readonlyname

Optional ReadonlyonInvalidationFailure

Readonlystore

Readonlytags

AbstractsetDirect

• setDirect(
      key: K,
      value: V,
      options?: CacheSetDirectOptions<CacheTag>,
  ): Promise<void>

  Directly write a value into this cache, following its configured write strategy.

  Use this instead of wrapWrite when the source function has already been called and you only need to propagate the result.

  Parameters

  • key: K
  • value: V
  • Optionaloptions: CacheSetDirectOptions<CacheTag>

  Returns Promise<void>

wrapDelete

• wrapDelete<TReturn, TArgs extends unknown[]>(
      fn: (...args: TArgs) => TReturn | Promise<TReturn>,
      keyFn: CacheKeyProvider<K, TArgs>,
      options?: CacheWrapDeleteOptions<TArgs, CacheTag>,
  ): (...args: TArgs) => Promise<TReturn>

  Returns a wrapped version of fn that invalidates a cache entry after call.

  Type Parameters

  • TReturn
  • TArgs extends unknown[]

  Parameters

  • fn: (...args: TArgs) => TReturn | Promise<TReturn>
  • keyFn: CacheKeyProvider<K, TArgs>
  • Optionaloptions: CacheWrapDeleteOptions<TArgs, CacheTag>

  Returns (...args: TArgs) => Promise<TReturn>

wrapInvalidate

• wrapInvalidate<TReturn, TArgs extends unknown[]>(
      fn: (...args: TArgs) => TReturn | Promise<TReturn>,
      options: CacheWrapInvalidateOptions<TArgs, CacheTag>,
  ): (...args: TArgs) => Promise<TReturn>

  Calls fn → Invalidates tags → Returns the fn result. For operations that affect cached data but produce no cacheable result, e.g. CreateAll/updateAll on a collection cache where no filter key can be derived from the output.

  Type Parameters

  • TReturn
  • TArgs extends unknown[]

  Parameters

  • fn: (...args: TArgs) => TReturn | Promise<TReturn>
  • options: CacheWrapInvalidateOptions<TArgs, CacheTag>

  Returns (...args: TArgs) => Promise<TReturn>