Interface OgcTilesetsRequest

Request envelope for tileset-discovery operations.

interface OgcTilesetsRequest {
    basePath?: string;
    cache?: HonuaCacheReadMode;
    collectionId: string | number;
    extraParams?: Record<string, string | number | boolean>;
    layout?: OgcEndpointLayout;
    refresh?: boolean;
    responseFormat?: string;
    signal?: AbortSignal;
    stacBasePath?: string;
    staleIfError?: boolean;
    staleIfErrorMs?: number;
    ttlMs?: number;
}

Hierarchy (view full)

Properties

basePath? cache? collectionId extraParams? layout? refresh? responseFormat? signal? stacBasePath? staleIfError? staleIfErrorMs? ttlMs?

Properties

OptionalbasePath

basePath?: string

Raw endpoint path prefix for the OGC API Tiles / Maps / Records / Processes families (the ones that do not use layout). Defaults to the family's Honua facade prefix (/ogc/tiles, /ogc/maps, /ogc/records, /ogc/processes). A raw third-party endpoint mounted at a different root (discovered by connect()) passes its service-root path here so every request resolves against the advertised layout. Ignored by OGC API Features (which uses layout) and STAC (which uses stacBasePath).

Optional Readonlycache

cache?: HonuaCacheReadMode

default reads and writes the adapter metadata cache. bypass skips cache lookup and write-through for endpoints that support SDK-local caching.

collectionId

collectionId: string | number

OptionalextraParams

extraParams?: Record<string, string | number | boolean>

Optionallayout

layout?: OgcEndpointLayout

Resolved endpoint layout. Omitted requests use the Honua facade fast path (/ogc/features/...); the backend-agnostic surfaces resolve a spec-driven layout once and thread it onto every request.

Optional Readonlyrefresh

refresh?: boolean

Revalidate even when an SDK-local metadata entry is present. Adapters send conditional validators when available and report refreshed on success.

OptionalresponseFormat

responseFormat?: string

Optional Readonlysignal

signal?: AbortSignal

OptionalstacBasePath

stacBasePath?: string

STAC-only: path prefix the STAC endpoints are mounted under. Defaults to /stac (Honua facade). A raw STAC API root passes "". Ignored by the OGC API Features methods (which use layout).

Optional ReadonlystaleIfError

staleIfError?: boolean

Allow a cached metadata entry to be returned as stale when refresh fails. Defaults to true; ignored when no cached metadata entry exists.

Optional ReadonlystaleIfErrorMs

staleIfErrorMs?: number

Optional stale fallback window surfaced to callers in HonuaCacheState.

Optional ReadonlyttlMs

ttlMs?: number

Optional freshness budget surfaced to callers in HonuaCacheState.

Settings

Member Visibility

On This Page

Properties