Skip to content

@eodash/eodash / @eodash/stac / SearchParams

Interface: SearchParams ​

A STAC API item search as a GET query.

Properties ​

bbox? ​

Comma separated: the repeated form a GET would send is ignored.

ts
optional bbox?: string;

collections? ​

ts
optional collections?: string;

datetime? ​

An instant, or an interval as ../end, start/.. or start/end.

ts
optional datetime?: string;

fields? ​

The properties to return, prefixed - to leave one out.

ts
optional fields?: string;

filter? ​

A CQL2-text expression.

ts
optional filter?: string;

filter-lang? ​

ts
optional filter-lang?: "cql2-text";

limit? ​

ts
optional limit?: number;

sortby? ​

A property name, prefixed - to sort descending.

ts
optional sortby?: string;