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

    Interface HonuaOgcRecordsSearchAllRequest

    Query parameters for OGC API Records /collections/{catalogId}/items.

    interface HonuaOgcRecordsSearchAllRequest {
        basePath?: string;
        bbox?: string | readonly [number, number, number, number];
        cache?: HonuaCacheReadMode;
        collectionId: string | number;
        datetime?: string;
        externalIds?: string | readonly string[];
        extraParams?: Record<string, string | number | boolean>;
        filter?: string;
        filterCrs?: string;
        filterLang?: string & {} | "cql2-text" | "cql2-json";
        ids?: string | readonly (string | number)[];
        layout?: OgcEndpointLayout;
        limit?: number;
        maxPages?: number;
        maxResponseBytes?: number;
        offset?: number;
        pageSize?: number;
        profile?: string | readonly string[];
        properties?: string | readonly string[];
        q?: string | readonly string[];
        refresh?: boolean;
        responseFormat?: string;
        signal?: AbortSignal;
        sortby?: string;
        stacBasePath?: string;
        staleIfError?: boolean;
        staleIfErrorMs?: number;
        ttlMs?: number;
        type?: string | readonly string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    basePath? bbox? cache? collectionId datetime? externalIds? extraParams? filter? filterCrs? filterLang? ids? layout? limit? maxPages? maxResponseBytes? offset? pageSize? profile? properties? q? refresh? responseFormat? signal? sortby? stacBasePath? staleIfError? staleIfErrorMs? ttlMs? type?

    Properties

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

    bbox?: string | readonly [number, number, number, number]
    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: string | number
    datetime?: string
    externalIds?: string | readonly string[]

    External resource identifiers associated with the record.

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

    Optional CQL2 filter when the server advertises the Records filtering class.

    filterCrs?: string
    filterLang?: string & {} | "cql2-text" | "cql2-json"
    ids?: string | readonly (string | number)[]
    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.

    limit?: number
    maxPages?: number

    Hard cap on the number of pages to fetch (defaults to 100).

    maxResponseBytes?: number

    Maximum decoded response-body bytes accepted before metadata parsing. Adapters that consume bounded discovery documents set this explicitly so a missing or dishonest Content-Length cannot turn metadata discovery into an unbounded allocation. The limit is enforced while streaming the body, not only from response headers.

    offset?: number
    pageSize?: number

    Maximum number of records to request per page.

    profile?: string | readonly string[]
    properties?: string | readonly string[]
    q?: string | readonly string[]

    Free-text record search terms. Arrays serialize as OGC form-style CSV.

    refresh?: boolean

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

    responseFormat?: string
    signal?: AbortSignal
    sortby?: string
    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).

    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.

    staleIfErrorMs?: number

    Optional stale fallback window surfaced to callers in HonuaCacheState.

    ttlMs?: number

    Optional freshness budget surfaced to callers in HonuaCacheState.

    type?: string | readonly string[]

    Record resource type filter, e.g. dataset, service, map, collection.

    Settings

    Member Visibility

    On This Page

    Properties