Class default

constructor

• new default(__namedParameters?: CacheOptions): default

  Parameters

  • __namedParameters: CacheOptions = {}

  Returns default

maxSize

ttl

checkVersions

• checkVersions(): Promise<VersionedCacheVersionData>

  Check versions from server

  Returns Promise<VersionedCacheVersionData>

  Version payload

clear

• clear(): void

  Clear entire cache

  Returns void

delete

• delete(key: string): void

  Delete specific key from cache

  Parameters

  • key: string

    Cache key

  Returns void

get

• get<T>(
      key: string,
      collection: string | undefined,
      fetchFn: () => Promise<T>,
  ): Promise<T>

  Get item from cache or fetch it

  Type Parameters

  • T

  Parameters

  • key: string

    Cache key

  • collection: string | undefined

    Collection name (items, rivens, etc.)

  • fetchFn: () => Promise<T>

    Function to fetch data if cache miss

  Returns Promise<T>

  Cached or freshly fetched value

has

• has(key: string): boolean

  Check if key exists in cache (and is valid)

  Parameters

  • key: string

    Cache key

  Returns boolean

  Whether the key is present and unexpired

refresh

• refresh<T>(
      key: string,
      collection: string,
      fetchFn: () => Promise<T>,
  ): Promise<T>

  Refresh cache entry

  Type Parameters

  • T

  Parameters

  • key: string

    Cache key

  • collection: string

    Collection name

  • fetchFn: () => Promise<T>

    Function to fetch fresh data

  Returns Promise<T>

  Fresh value

set

• set<T>(key: string, value: T, collection?: string): void

  Set item in cache

  Type Parameters

  • T

  Parameters

  • key: string

    Cache key

  • value: T

    Value to cache

  • Optionalcollection: string

    Collection name for version tracking

  Returns void

shouldRefresh

• shouldRefresh(collection: string): Promise<boolean>

  Check if collection should be refreshed

  Parameters

  • collection: string

    Collection name

  Returns Promise<boolean>

  Whether the cached collection version is stale

size

• size(): number

  Get cache size

  Returns number

  Number of in-memory entries