@honua/sdk-js
    Preparing search index...

    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 Summary)

    Index

    Properties

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

    Properties

    allowInvalid?: boolean

    Return invalid packages with diagnostics instead of throwing HonuaMapPackageError.

    cache?: false | MapPackageFetchCache

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

    client: HonuaClient
    disableDefaultStyleRefResolver?: boolean

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

    headers?: HeadersInit
    maxAgeMs?: number

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

    now?: number | Date
    requireStyleRefResolution?: boolean

    Treat unresolved style refs as validation errors instead of warnings.

    resolvePath?: MapPackagePathResolver

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

    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.

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties