Class HonuaStacSearch

constructor

• new HonuaStacSearch(options): HonuaStacSearch

• Parameters

  • options: HonuaStacSearchOptions

  Returns HonuaStacSearch

Readonlyclient

collection

• collection(request): Promise<HonuaOgcCollectionMetadata>

• Parameters

  • request: OgcCollectionRequest

  Returns Promise<HonuaOgcCollectionMetadata>

collections

• collections(request?): Promise<HonuaOgcCollectionsResponse>

• Parameters

  • request: OgcMetadataRequest = {}

  Returns Promise<HonuaOgcCollectionsResponse>

item

• item(request): Promise<HonuaStacItemResponse>

• Parameters

  • request: {
        collectionId: string | number;
        extraParams?: Record<string, string | number | boolean>;
        itemId: string | number;
        responseFormat?: string;
        signal?: AbortSignal;
        stacBasePath?: string;
    }

    • collectionId: string | number

    • OptionalextraParams?: Record<string, string | number | boolean>

    • itemId: string | number

    • OptionalresponseFormat?: string

    • Optionalsignal?: AbortSignal

    • OptionalstacBasePath?: string

  Returns Promise<HonuaStacItemResponse>

landing

• landing(request?): Promise<HonuaStacLandingResponse>

• Parameters

  • request: OgcMetadataRequest = {}

  Returns Promise<HonuaStacLandingResponse>

search

• search(request?): Promise<HonuaStacItemCollectionResponse>

• Parameters

  • request: StacSearchRequest = {}

  Returns Promise<HonuaStacItemCollectionResponse>

searchAll

• searchAll(request?): Promise<HonuaStacItemResponse[]>

• Parameters

  • request: HonuaStacSearchAllRequest = {}

  Returns Promise<HonuaStacItemResponse[]>

searchStream

• searchStream(request?): AsyncGenerator<HonuaStacItemResponse[], void, undefined>

• Parameters

  • request: HonuaStacSearchAllRequest = {}

  Returns AsyncGenerator<HonuaStacItemResponse[], void, undefined>

supportsPostSearch

• supportsPostSearch(signal?): Promise<boolean>

• Whether the API advertises POST /search.

  STAC API - Item Search requires GET /search and makes POST optional, so the POST support has to be discovered rather than assumed: servers list the endpoint on the landing page as a rel="search" link per method (stac-fastapi / pgstac and stac-server emit both a GET and a POST link). The probe runs at most once per instance and resolves to false when the landing page is unreachable or advertises no POST search link, so callers fall back to the universally supported GET.

  Parameters

  • Optionalsignal: AbortSignal

  Returns Promise<boolean>