API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceAssetInspection

@codexo/exojs / assets / stable

9
props
0
methods
0
events
Import
import { AssetInspection } from '@codexo/exojs'
Properties9
aliases: readonly string[]
Every source string seen for this key, sorted. Several spellings can name one canonical asset.
background: boolean
true only while this key is genuinely parked in the low-priority background queue - always in lockstep with state === 'queued', and never true on a row whose state has already settled to 'ready' or 'failed'.
canonicalKey: string
The canonical key this row describes - the same key the claim, in-flight and resource maps use.
claims: number
The number of distinct claim scopes currently holding this key - the same refcount a release decrements and that reaches zero to evict. This is a scope count, not a count of consumer handles/refs or get() calls: several handles sharing one scope, or several get() calls for the same source, still report 1 here.
inFlight: boolean
true while a fetch for this key is actively in flight (network request or handler load).
locator: string
The canonicalized source this asset resolves to.
owners: readonly AssetOwnerInspectionOne row of Loader.inspect's diagnostic snapshot: everything a developer needs to reason about a single canonical asset without reaching into `Loader`'s private…[]
The scopes currently holding this key, sorted by id. Empty for a resident-but-unowned asset.
state: "failed" | "idle" | "loading" | "queued" | "ready"
Where this key currently sits in the load lifecycle: 'idle' (claimed but its fetch has not started), 'queued' (parked in the low-priority background lane), 'loading' (fetch in flight), 'ready' (payload resident and readable), or 'failed' (the last fetch attempt errored). A row reports exactly one of these five, chosen by priority: a 'failed' or 'ready' outcome always wins over 'queued'/'loading', so a row can never claim to be both settled and still pending. A key can have more than one live handle/ref sharing it - multiple Assets.from() leaves or get() calls joined onto the same source, whose individual outcomes CAN diverge (e.g. one ref's parse() throws while a sibling ref's succeeds; AssetRef._fill fails only the ref whose parse threw). state reports the REPRESENTATIVE handle/ref's outcome - the first one registered for this key - not an aggregate across every handle/ref sharing it; a divergent sibling's outcome is not visible here.
type: AssetConstructorAny abstract or concrete constructor whose instances are the resource an asset type produces (e.g. `typeof Texture`, `typeof Sound`). Constructors act as the d…
The asset type constructor this key was resolved under.
Source
src/assets/AssetResidency.ts