Class MultiTierCache<K, V, Tiers, CacheTag>Abstract

constructor

• new MultiTierCache<
      K,
      V,
      Tiers extends readonly TierLike<K, V, CacheTag, any>[],
      CacheTag extends string = string,
  >(
      name: string,
      tiers: Tiers,
      onInvalidationFailure?: OnInvalidationFailure,
  ): MultiTierCache<K, V, Tiers, CacheTag>

  Type Parameters

  • K
  • V
  • Tiers extends readonly TierLike<K, V, CacheTag, any>[]
  • CacheTag extends string = string

  Parameters

  • name: string
  • tiers: Tiers
  • OptionalonInvalidationFailure: OnInvalidationFailure

  Returns MultiTierCache<K, V, Tiers, CacheTag>

Readonlyname

Optional ReadonlyonInvalidationFailure

wrap

• wrap<TArgs extends unknown[]>(
      fn: (...args: TArgs) => V | Promise<V>,
      keyFn: CacheKeyProvider<K, TArgs>,
      options?: Partial<
          Record<TierName<Tiers>, CacheWrapOptions<V, TArgs, CacheTag>>,
      >,
  ): (...args: TArgs) => Promise<V>

  Type Parameters

  • TArgs extends unknown[]

  Parameters

  • fn: (...args: TArgs) => V | Promise<V>
  • keyFn: CacheKeyProvider<K, TArgs>
  • Optionaloptions: Partial<Record<TierName<Tiers>, CacheWrapOptions<V, TArgs, CacheTag>>>

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

wrapDelete

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

  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>

  Type Parameters

  • TReturn
  • TArgs extends unknown[]

  Parameters

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

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

wrapWrite

• wrapWrite<TArgs extends unknown[]>(
      fn: (...args: TArgs) => V | Promise<V>,
      keyFn: OuterWR<Tiers> extends true
          ? ResultCacheKeyProvider<K, V, TArgs>
          : CacheKeyProvider<K, TArgs>,
      options?: MultiWrapWriteOptions<V, TArgs, CacheTag, Tiers>,
  ): (...args: TArgs) => Promise<V>

  Type Parameters

  • TArgs extends unknown[]

  Parameters

  • fn: (...args: TArgs) => V | Promise<V>
  • keyFn: OuterWR<Tiers> extends true
        ? ResultCacheKeyProvider<K, V, TArgs>
        : CacheKeyProvider<K, TArgs>
  • Optionaloptions: MultiWrapWriteOptions<V, TArgs, CacheTag, Tiers>

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