Docs: improve docs

This commit is contained in:
Pieter Vander Vennet 2025-02-03 14:04:25 +01:00
parent 123c50a5c0
commit 103ad364f9

View file

@ -50,6 +50,12 @@ export interface GeocodingOptions {
export default interface GeocodingProvider {
readonly name: string
/**
* Performs search.
* Note: the result _must_ return an empty list in the case of no results.
* Undefined might be interpreted by clients as "still running"
*/
search(query: string, options?: GeocodingOptions): Promise<GeocodeResult[]>
/**