@eodash/eodash / @eodash/stac / createEodashCollection

Function: createEodashCollection() ​

ts
function createEodashCollection(url, options?, buildContext?): Promise<Reader>;

Creates a collection reader for querying dates and generating map layers. Selects an API, GeoParquet, or static collection reader based on the options and collection metadata.

Parameters ​

url ​

string

Collection URL or API search endpoint

options? ​

api? ​

boolean

Whether the collection uses a STAC API endpoint

client? ​

AxiosInstance

Custom HTTP client instance

color? ​

string

Color assigned to layers generated from this collection

fetch? ​

{ (input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Custom fetch implementation (e.g. for SSRF-protected binary range requests)

maxItems? ​

number

Maximum items to retrieve per search query

rasterEndpoint? ​

string

Base URL for raster tile rendering

renders? ​

Record<string, Record<string, Render>>

Render configurations mapped by collection ID

stac? ​

STACCollection

The collection document, for a caller that has already read it

tileMatrixSets? ​

Record<string, any> | null

TileMatrixSet configurations keyed by projection

upscalingEndpoints? ​

( | string | { scaleFactor?: number; titilerVersion?: 1 | 2; url: string; })[]

Tile endpoints for high-resolution rendering

viewProjection? ​

string

Map view projection code used to namespace layer identifiers

buildContext? ​

BuildContext = {}

Default build context applied to layer builds

Returns ​

Promise<Reader>