API reference

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

interfaceLoaderOptions

@codexo/exojs / assets / stable

Construction options for Loader. `basePath` is prepended to relative asset paths at fetch time. `concurrency` caps the number of simultaneous background-queue fetches (default `6`). `cache` configures caching, and is optional: with nothing passed, every acquisition goes straight to the network and no cache machinery runs at all. One or more CacheStore instances configure a single cache-first route over them; an AssetCache configures routes and policies explicitly. `connectivity` is what makes an acquisition's network permission known to the cache and to a streaming asset type. Application supplies its own, so this is only for a loader built by hand.

props

methods

events

Import

import { LoaderOptions } from '@codexo/exojs'

Construction options for Loader.

`basePath` is prepended to relative asset paths at fetch time. `concurrency` caps the number of simultaneous background-queue fetches (default `6`).

`cache` configures caching, and is optional: with nothing passed, every acquisition goes straight to the network and no cache machinery runs at all. One or more CacheStore instances configure a single cache-first route over them; an AssetCache configures routes and policies explicitly.

`connectivity` is what makes an acquisition's network permission known to the cache and to a streaming asset type. Application supplies its own, so this is only for a loader built by hand.

Properties5

basePath?: string

cache?: AssetCacheThe application's caching configuration: which stores exist, which asset types use which of them, and in what order the cache and the network are consulted. Th… | CacheStorePhysical storage for cache records. A store is asset-agnostic by contract: it never sees an asset type, a factory, a codec or a runtime resource, and it does n… | readonly CacheStorePhysical storage for cache records. A store is asset-agnostic by contract: it never sees an asset type, a factory, a codec or a runtime resource, and it does n…[]

concurrency?: number

connectivity?: ConnectivityWhether the application should reach the network at all, right now. Two separate questions, deliberately never equated: - state - what the environment appears…

Whether acquisitions may reach the network, and what the host reports. The loader never subscribes to it and never changes it: it reads a snapshot when an acquisition starts, and passes that value on. Omitted, every acquisition runs unrestricted.

fetchOptions?: RequestInit

Source

src/assets/Loader.ts