Skip to content

Types ​

@eodash/stac includes full TypeScript definitions. See the type reference for auto-generated API details.

STAC documents ​

Every STAC extension and custom property supported by eodash is typed. For catalog structuring details, see STAC Concepts.

ConceptTypes
Items and collections with eodash fieldsSTACItem, STACCollection
Eodash extension fieldsItemExtensions, CollectionExtensions
Web map linksWMSLink, WMTSLink, XYZLink, TileJSONLink, VectorTileLink, MapboxStyleDocumentLink
Data assetsGeoTIFFAsset, GeoJSONAsset, FlatGeobufAsset, GeoZarrAsset, GeoDBAsset
ProjectionsProjection
Render extensionRender
AuthenticationAuthScheme, AuthRefs
Pre-aggregated datesPreAggregationLink, AggregationCollection
Raster formsRasterForm
Flat stylesEodashStyleJson

Extending the baseline ​

STACItem and STACCollection combine standard STAC specifications with eodash-supported extensions:

ts
type STACItem = BaseItem<ItemExtensions, STACLink, STACAsset>;

BaseItem, BaseCollection, and BaseAsset accept extension interfaces as generic parameters. If your catalog includes custom metadata fields, you can type them without redeclaring base STAC properties:

ts
import type { BaseItem } from "@eodash/stac";

interface MyExtensions {
  "my:quality"?: number;
}

type MyItem = BaseItem<MyExtensions>;

Base STAC types are adapted from stac-ts.