valhalla-wasm API
    Preparing search index...

    Interface RouterOptions

    Session configuration for a compatible, immutable dataset.

    interface RouterOptions {
        manifestUrl: string;
        memoryBudgetBytes?: number;
        onProgress?: (event: ProgressEvent) => void;
        retries?: number;
        searchMemory?: SearchMemoryOptions;
        timeoutMs?: number;
        transport?: TileTransport;
        wasmMemory?: WasmMemoryOptions;
        wasmUrl?: string | URL;
        workerFactory?: () => Worker;
        workerUrl?: string | URL;
    }
    Index
    manifestUrl memoryBudgetBytes? onProgress? retries? searchMemory? timeoutMs? transport? wasmMemory? wasmUrl? workerFactory? workerUrl?
    manifestUrl: string

    Versioned manifest URL. Relative URLs resolve against the page; the parent directory must match its release ID.

    memoryBudgetBytes?: number

    Retained decoded-tile cache budget in bytes: 1 KiB–128 MiB, default 32 MiB. Must fit the dataset's largest tile. This is not a total-worker memory limit.

    onProgress?: (event: ProgressEvent) => void

    Receives worker progress on the main thread. Callback exceptions are ignored; avoid blocking UI work.

    retries?: number

    Additional attempts for transient fetch failures, integer 0–5; defaults to 2. Zero also disables the single shared startup retry for opaque worker-load failures or WASM initialization timeouts.

    searchMemory?: SearchMemoryOptions

    Search-label reservations and cleanup policy. Omitted fields use SDK defaults, independently of the decoded-tile cache budget. Changes take effect on the next initialization.

    timeoutMs?: number

    Fetch/worker-load deadline per attempt in integer ms, 1–60,000; default 10,000. WASM startup receives at least 10 seconds.

    transport?: TileTransport

    Tile delivery backend. Defaults to indexed-tar.

    wasmMemory?: WasmMemoryOptions

    Per-worker linear memory: default 128 MiB initial, 512 MiB maximum. Changes apply to the next worker instance.

    wasmUrl?: string | URL

    Optional matching WASM binary. Relative URLs resolve against the page. Defaults to the package's bundled binary.

    workerFactory?: () => Worker

    Takes precedence over workerUrl. Each call must return a fresh worker implementing this SDK version's protocol. Disables automatic worker-startup retries. Advanced integration only.

    workerUrl?: string | URL

    Optional matching module worker. Relative URLs resolve against the page; cross-origin URLs need CORS and blob-worker CSP permission.

    Settings
    Member Visibility

    On This Page
    Properties