ThemeParks.wiki Parks API - v2.0.0
    Preparing search index...

    Class CacheLib

    Index
    constructor
    cleanupExpired clear clearAll clearByClassName delete enableTemporaryMode enforceSizeLimit expiresAt get getAllEntries has isTemporary keys set size startCleanup stats stopCleanup wrap

    • Remove all expired entries from cache

      Returns number

    • Delete cached entries.

      Like clearByClassName, this is a re-fetch and steps over persistent operational state (see cacheKeys.ts). The broad gesture is the one an operator reaches for when a symptom spans several destinations, which is exactly when quietly discarding what we have observed does the most damage. Pass includePersistent for a genuine full wipe.

      Parameters

      • __namedParameters: { includePersistent?: boolean } = {}

      Returns void

    • Delete cached entries across every destination. Returns number deleted.

      Steps over persistent operational state for the same reason clearByClassName does; pass includePersistent for a full wipe.

      Parameters

      • __namedParameters: { includePersistent?: boolean } = {}

      Returns number

    • Delete all cache entries whose key contains the given class name. Matches both plain keys (ClassName:method:args) and prefixed keys (prefix:ClassName:method:args). Returns the number of deleted entries.

      Keys carrying a PERSISTENT_KEY_FRAGMENTS fragment are stepped over: this call means "refetch from upstream", not "forget what we have observed". Pass includePersistent to sweep those too, which is a full reset of the destination rather than a flush, and is what test setup wants.

      Parameters

      • className: string
      • __namedParameters: { includePersistent?: boolean } = {}

      Returns number

    • Parameters

      • key: string

      Returns void

    • Enable temporary mode - use in-memory cache that doesn't persist Must be called before any cache operations

      Returns void

    • Enforce cache size limit by removing least recently accessed entries. Called periodically from set() rather than on every write.

      Returns void

    • When the entry under key expires, as a millisecond timestamp. Null when there is no live entry.

      Parameters

      • key: string

      Returns number | null

    • Parameters

      • key: string

      Returns any

    • Get all cache entries with metadata

      Returns {
          expiresAt: number;
          isExpired: boolean;
          key: string;
          lastAccess: number;
          size: number;
          value: any;
      }[]

    • Parameters

      • key: string

      Returns boolean

    • Check if cache is in temporary mode

      Returns boolean

    • Type Parameters

      • T

      Parameters

      • key: string
      • value: T
      • ttlSeconds: number = 60

      Returns void

    • Start automatic cleanup of expired entries

      Returns void

    • Get cache statistics

      Returns { active: number; expired: number; total: number }

    • Stop automatic cleanup

      Returns void

    • Cache-with-dedup wrapper. Concurrent callers on a cache miss for the same key share a single execution rather than each running fn independently.

      Type Parameters

      • T

      Parameters

      • key: string
      • fn: () => T | Promise<T>
      • ttl: number | ((result: T) => number | Promise<number>)

        Either a fixed TTL in seconds, or a callback that derives a TTL from the function's result (e.g. for OAuth tokens that expire on a server-supplied schedule).

      • Optionalcaller: () => Omit<HttpCaller, "retryCount">

        Returns who calls, for the method cache observer (see setMethodCacheObserver). Called only on a hit while an observer is set.

      Returns Promise<T>

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods