Interface WatchMapPackageOptions

interface WatchMapPackageOptions {
    allowInvalid?: boolean;
    applyUpdates?: boolean;
    cache?: false | MapPackageFetchCache;
    client: HonuaClient;
    debounceMs?: number;
    disableDefaultStyleRefResolver?: boolean;
    headers?: HeadersInit;
    immediate?: boolean;
    initialPackage?: HonuaMapPackage;
    intervalMs?: number;
    maxAgeMs?: number;
    now?: number | Date;
    onError?: ((error: unknown) => void | Promise<void>);
    onEvent?: ((event: MapPackageWatchEvent) => void | Promise<void>);
    onUpdate?: ((event: {
        applied: boolean;
        diff: undefined | MapPackageDiff;
        result: FetchMapPackageResult;
        type: "updated";
    }) => void | Promise<void>);
    realtime?: false | MapPackageRealtimeWatchOptions;
    requireStyleRefResolution?: boolean;
    resolvePath?: MapPackagePathResolver;
    resolveStyleRef?: StyleRefResolver;
    runtime?: HonuaMapRuntime;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

allowInvalid? applyUpdates? cache? client debounceMs? disableDefaultStyleRefResolver? headers? immediate? initialPackage? intervalMs? maxAgeMs? now? onError? onEvent? onUpdate? realtime? requireStyleRefResolution? resolvePath? resolveStyleRef? runtime? signal?

Properties

Optional ReadonlyallowInvalid

allowInvalid?: boolean

Return invalid packages with diagnostics instead of throwing HonuaMapPackageError.

Optional ReadonlyapplyUpdates

applyUpdates?: boolean

Defaults to true when runtime is supplied.

Optional Readonlycache

cache?: false | MapPackageFetchCache

In-memory response cache. Omit for a per-client default; pass false to bypass SDK validators.

Readonlyclient

client: HonuaClient

Optional ReadonlydebounceMs

debounceMs?: number

Delay changed-package application to coalesce rapid fetches. Defaults to 0.

Optional ReadonlydisableDefaultStyleRefResolver

disableDefaultStyleRefResolver?: boolean

Disable the default /ogc/styles StyleRef resolver when no callback is supplied.

Optional Readonlyheaders

headers?: HeadersInit

Optional Readonlyimmediate

immediate?: boolean

Fetch immediately on watcher creation. Defaults to true.

Optional ReadonlyinitialPackage

initialPackage?: HonuaMapPackage

Previous package snapshot for diffing when no runtime is supplied.

Optional ReadonlyintervalMs

intervalMs?: number

Polling cadence. Defaults to 30 seconds.

Optional ReadonlymaxAgeMs

maxAgeMs?: number

Emit a stale-package warning when the package timestamp is older than this many ms.

Optional Readonlynow

now?: number | Date

Optional ReadonlyonError

onError?: ((error: unknown) => void | Promise<void>)

Optional ReadonlyonEvent

onEvent?: ((event: MapPackageWatchEvent) => void | Promise<void>)

Optional ReadonlyonUpdate

onUpdate?: ((event: {
    applied: boolean;
    diff: undefined | MapPackageDiff;
    result: FetchMapPackageResult;
    type: "updated";
}) => void | Promise<void>)

Optional Readonlyrealtime

realtime?: false | MapPackageRealtimeWatchOptions

Realtime channel configuration. Omit to use package-advertised channels; pass false to force polling.

Optional ReadonlyrequireStyleRefResolution

requireStyleRefResolution?: boolean

Treat unresolved style refs as validation errors instead of warnings.

Optional ReadonlyresolvePath

resolvePath?: MapPackagePathResolver

Override id-to-path resolution. The default is /api/v1/map-packages/{encodeURIComponent(id)}.

Optional ReadonlyresolveStyleRef

resolveStyleRef?: StyleRefResolver

Resolve out-of-band style refs and inline successful bodies into the returned package. When omitted, defaults to resolving styleRefs.styleId against the server's OGC API – Styles surface (GET /ogc/styles/{styleId}) via createOgcStyleRefResolver. Pass a callback to override that path (back-compat), or set disableDefaultStyleRefResolver to skip it.

Optional Readonlyruntime

runtime?: HonuaMapRuntime

Runtime to update after a changed package is fetched.

Optional Readonlysignal

signal?: AbortSignal

Settings

Member Visibility

On This Page

Properties