Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface CacheStatsSnapshot

    Snapshot of all three cache levels exposed by __luxarDebug.cache.getStats(). Levels that are absent return null for that field; the caller can render them as "disabled".

    network, demand, prefetch, and health are optional so callers keying off {l0, l1, l2} keep working without changes.

    interface CacheStatsSnapshot {
        l0: DecompressedChunkCacheStats | null;
        slice: SliceCacheStats | null;
        l1: CacheStats | null;
        l2:
            | {
                size: number;
                count: number;
                reads: number;
                writes: number;
                misses: number;
                canceledReads: number;
                activeReads: number;
                queuedReads: number;
                maxSize?: number;
                oversizedWriteSkipped?: number;
                quotaWriteSkipped?: number;
                evictions?: number;
                writeFailures?: number;
                corruptedEntries?: number;
                metadataParseFailures?: number;
                orphanedFilesRemoved?: number;
            }
            | null;
        l2WriteQueue?: | {
            depth: number;
            pendingBytes: number;
            inFlight: number;
            dropped: number;
            concurrency: number;
            maxDepth: number;
            maxBytes: number;
        }
        | null;
        network?: | {
            bytesTransferred: number;
            requestCount: number;
            bandwidth: number;
            totalBytesServed: number;
            totalRequestsServed: number;
        }
        | null;
        demand?: { l1Hits: number; l2Hits: number; networkRequests: number }
        | null;
        prefetch?: { queued: number; inFlight: number; enabled: boolean } | null;
        health?:
            | {
                validationMode: CacheValidationMode;
                lastValidatedAt: number
                | null;
                unvalidatedExternalDataset: boolean;
                opfsAvailable: boolean;
            }
            | null;
        clearOnInitCount?: number;
    }
    Index
    l0 slice l1 l2 l2WriteQueue? network? demand? prefetch? health? clearOnInitCount?
    l0: DecompressedChunkCacheStats | null
    slice: SliceCacheStats | null

    S-cache (decoded per-slice geometry) — null when the SliceCache is off.

    l1: CacheStats | null
    l2:
        | {
            size: number;
            count: number;
            reads: number;
            writes: number;
            misses: number;
            canceledReads: number;
            activeReads: number;
            queuedReads: number;
            maxSize?: number;
            oversizedWriteSkipped?: number;
            quotaWriteSkipped?: number;
            evictions?: number;
            writeFailures?: number;
            corruptedEntries?: number;
            metadataParseFailures?: number;
            orphanedFilesRemoved?: number;
        }
        | null

    Type Declaration

    • {
          size: number;
          count: number;
          reads: number;
          writes: number;
          misses: number;
          canceledReads: number;
          activeReads: number;
          queuedReads: number;
          maxSize?: number;
          oversizedWriteSkipped?: number;
          quotaWriteSkipped?: number;
          evictions?: number;
          writeFailures?: number;
          corruptedEntries?: number;
          metadataParseFailures?: number;
          orphanedFilesRemoved?: number;
      }
      • size: number
      • count: number
      • reads: number
      • writes: number
      • misses: number
      • canceledReads: number

        Reads canceled before filesystem I/O; excluded from the hit-rate denominator.

      • activeReads: number
      • queuedReads: number
      • OptionalmaxSize?: number

        Configured byte budget (fixed OPFS/disk cap).

      • OptionaloversizedWriteSkipped?: number
      • OptionalquotaWriteSkipped?: number
      • Optionalevictions?: number
      • OptionalwriteFailures?: number
      • OptionalcorruptedEntries?: number
      • OptionalmetadataParseFailures?: number
      • OptionalorphanedFilesRemoved?: number
    • null
    l2WriteQueue?:
        | {
            depth: number;
            pendingBytes: number;
            inFlight: number;
            dropped: number;
            concurrency: number;
            maxDepth: number;
            maxBytes: number;
        }
        | null

    Background L2 write-queue backpressure (depth / in-flight / dropped).

    network?:
        | {
            bytesTransferred: number;
            requestCount: number;
            bandwidth: number;
            totalBytesServed: number;
            totalRequestsServed: number;
        }
        | null

    Type Declaration

    • {
          bytesTransferred: number;
          requestCount: number;
          bandwidth: number;
          totalBytesServed: number;
          totalRequestsServed: number;
      }
      • bytesTransferred: number

        Bytes fetched over the network (L3) — excludes cache-served bytes.

      • requestCount: number

        Count of actual network fetches (L3).

      • bandwidth: number

        Current network bandwidth (bytes/sec, ~10s sliding window).

      • totalBytesServed: number

        Cumulative bytes delivered to demand callers across ALL tiers (L1 + L2 + network). Unlike bytesTransferred, this stays non-zero on a warm/cache-served reload, so the monitor's "data loaded" figure reflects real I/O even with zero network.

      • totalRequestsServed: number

        Count of demand reads served across all tiers.

    • null
    demand?: { l1Hits: number; l2Hits: number; networkRequests: number } | null
    prefetch?: { queued: number; inFlight: number; enabled: boolean } | null
    health?:
        | {
            validationMode: CacheValidationMode;
            lastValidatedAt: number
            | null;
            unvalidatedExternalDataset: boolean;
            opfsAvailable: boolean;
        }
        | null

    Type Declaration

    • {
          validationMode: CacheValidationMode;
          lastValidatedAt: number | null;
          unvalidatedExternalDataset: boolean;
          opfsAvailable: boolean;
      }
      • validationMode: CacheValidationMode

        Validation mode the dataset is using (or 'none' if external + no TTL).

      • lastValidatedAt: number | null

        Wall-clock millis at last successful validation, or null.

      • unvalidatedExternalDataset: boolean

        true when the dataset has no content_hash AND no TTL is configured — surfaced as a UI warning since the cache may be stale indefinitely.

      • opfsAvailable: boolean

        S2: true when OPFS is available and L2 is operational, or when caching is disabled (no L2 expected). false only when caching is enabled but OPFS could not be acquired — drives the opfs-unavailable status badge.

    • null
    clearOnInitCount?: number

    S4: number of times ?clearCache triggered a clearAll on init for the active store. Surfaced so E2E tests can assert that a clear actually ran rather than only checking that stats survived.

    Settings
    Member Visibility

    On This Page
    Properties