Interface DynamicStacSearchRequestExperimental

interface DynamicStacSearchRequest {
    bbox?: readonly [number, number, number, number];
    collections?: readonly string[];
    datetime?: string;
    fields?: {
        exclude?: readonly string[];
        include?: readonly string[];
    };
    filter?: string | Readonly<Record<string, unknown>>;
    filterLang?: "cql2-text" | "cql2-json";
    ids?: readonly string[];
    intersects?: Record<string, unknown>;
    limit?: number;
    method?: StacSearchMethod;
    next?: string;
    nextBody?: Readonly<Record<string, unknown>>;
    nextParams?: Readonly<Record<string, string>>;
    offset?: number;
    signal?: AbortSignal;
    sortby?: string | readonly StacSortField[];
}

Hierarchy (view full)

Properties

bbox? collections? datetime? fields? filter? filterLang? ids? intersects? limit? method? next? nextBody? nextParams? offset? signal? sortby?

Properties

Optional Experimentalbbox

bbox?: readonly [number, number, number, number]

Optional Experimentalcollections

collections?: readonly string[]

Optional Experimentaldatetime

datetime?: string

Optional Experimentalfields

fields?: {
    exclude?: readonly string[];
    include?: readonly string[];
}

Subset of asset / item properties to return.

Optional Experimentalfilter

filter?: string | Readonly<Record<string, unknown>>

Optional ExperimentalfilterLang

filterLang?: "cql2-text" | "cql2-json"

Optional Experimentalids

ids?: readonly string[]

Optional Experimentalintersects

intersects?: Record<string, unknown>

Optional Experimentallimit

limit?: number

Optional Readonly Experimentalmethod

method?: StacSearchMethod

auto discovers POST support once and otherwise uses standard GET search.

Optional Experimentalnext

next?: string

Server-driven page token. Optional support for STAC servers that advertise an opaque ?next=… token instead of offset.

Optional ExperimentalnextBody

nextBody?: Readonly<Record<string, unknown>>

Opaque continuation body members captured from a POST rel="next" link ({ "method": "POST", "body": { "token": "next:…" }, "merge": true }). Merged over the serialized POST /search body.

Optional ExperimentalnextParams

nextParams?: Readonly<Record<string, string>>

Opaque continuation query params captured verbatim from a server rel="next" link whose cursor is neither offset nor next (pgstac / stac-fastapi emit ?token=next:…). Merged over the serialized search params so the next page is requested exactly the way the server asked.

Optional Experimentaloffset

offset?: number

Numeric page offset. honua-server's /stac/search uses offset as the canonical paging token (its rel=next link href carries ?offset=N). Prefer this over next for honua-server compatibility.

Optional Experimentalsignal

signal?: AbortSignal

Optional Experimentalsortby

sortby?: string | readonly StacSortField[]

Settings

Member Visibility

On This Page

Properties