Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...
    Index
    url: string
    attrsUrls: readonly string[]

    Candidate root-attribute addresses, newest format first (query-preserving).

    resolvedAttrsUrl: string | null = null

    The candidate that last answered, so steady-state polling costs ONE request. Only the first probe of a format-2 dataset pays the extra 404.

    resolvedETag: string | null = null

    ETag of the document at resolvedAttrsUrl, sent back as If-None-Match so an unchanged scene answers 304 with no body.

    PAIRED with resolvedAttrsUrl — an ETag is only meaningful against the URL it came from, so this is cleared whenever the resolved document changes, and only ever sent to that one candidate.

    Only set from a probe that returned an ok verdict (see probe). That is what makes the 304 short-circuit sound: "unchanged since the ETag" is only equivalent to "still the scene we loaded" if the document that ETag names was itself confirmed to match the baseline.

    conditionalRequestsEnabled: boolean = true

    Disabled after a conditional fetch fails but the same request succeeds bare.

    pendingETag: string | null = null

    ETag seen by the in-flight probe; promoted by probe on ok.

    expectedHash: string | null
    expectedAttrsJson: string | null
    intervalMs: number
    fetchImpl: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
      • Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>
      • Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    consecutiveFailures: number = 0
    timer: Timeout | null = null
    lastProbeAt: number = 0
    probeInFlight: boolean = false
    inFlightAbort: AbortController | null = null

    Abort handle for the probe currently in flight (timeout / disposal).

    disposed: boolean = false
    changed: boolean = false

    Terminal once the address demonstrably serves something else.

    • Whether this dataset URL is one the watchdog can meaningfully watch.

      Parameters

      • datasetUrl: string

      Returns boolean

    • Begin watching. No immediate probe: the caller baselines identity from the attrs it actually loaded, and an instant re-fetch would only race the load it just finished.

      Returns void

    • The document name the last successful probe was served from.

      undefined only before any probe has succeeded, which cannot happen on the paths that call this (they run after a body was read); rootAttributes falls back to sniffing the content in that case, which is the same answer it gave before the name was threaded through.

      Returns string | undefined