Whistle API
    Preparing search index...

    Interface BrowserWhistleOptions

    Browser factory configuration; all URLs resolve relative to document.baseURI.

    interface BrowserWhistleOptions {
        assetsUrl?: string | URL;
        cache?: "auto" | "none";
        modelUrl?: string | URL;
        onProgress?: (progress: LoadProgress) => void;
        signal?: AbortSignal;
        wasmUrl?: string | URL;
        workerUrl?: string | URL;
    }
    Index
    assetsUrl? cache? modelUrl? onProgress? signal? wasmUrl? workerUrl?
    assetsUrl?: string | URL

    CLI-generated asset directory, including its manifest and workers. Enables self-hosting with no upstream fallback. Cannot be combined with modelUrl or wasmUrl. A trailing slash is added when necessary.

    cache?: "auto" | "none"

    Use verified IndexedDB asset persistence or disable SDK persistence. Storage unavailability falls back to ordinary loading. none does not disable HTTP caching.

    'auto'

    modelUrl?: string | URL

    Mirror of the exact pinned model bytes. Defaults to the immutable official model URL.

    onProgress?: (progress: LoadProgress) => void

    Observer for asset loading and readiness; exceptions in the callback are ignored.

    signal?: AbortSignal

    Initialization-only cancellation; detached when the factory resolves.

    wasmUrl?: string | URL

    Mirror of the exact pinned WASM bytes. Defaults to packaged needle.wasm.

    workerUrl?: string | URL

    Matching module-worker URL; normally same-origin. Defaults to the packaged/asset-directory worker.

    Settings
    Member Visibility

    On This Page
    Properties