Interface FetchMapPackageOptions

interface FetchMapPackageOptions {
    allowInvalid?: boolean;
    cache?: false | MapPackageFetchCache;
    client: HonuaClient;
    disableDefaultStyleRefResolver?: boolean;
    headers?: HeadersInit;
    maxAgeMs?: number;
    now?: number | Date;
    requireStyleRefResolution?: boolean;
    resolvePath?: MapPackagePathResolver;
    resolveStyleRef?: StyleRefResolver;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

allowInvalid? cache? client disableDefaultStyleRefResolver? headers? maxAgeMs? now? requireStyleRefResolution? resolvePath? resolveStyleRef? signal?

Properties

Optional ReadonlyallowInvalid

allowInvalid?: boolean

Return invalid packages with diagnostics instead of throwing HonuaMapPackageError.

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 ReadonlydisableDefaultStyleRefResolver

disableDefaultStyleRefResolver?: boolean

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

Optional Readonlyheaders

headers?: HeadersInit

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 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 Readonlysignal

signal?: AbortSignal

Settings

Member Visibility

On This Page

Properties