This is the documentation of version 1.0.0-rc.0. Go to the latest version, 1.0.0-rc.5.

Function geocodeOne

geocodeOne(
queryOrParams: string | Omit<GeocodingParams, "limit">,
): Promise<Place<GeocodingProps>>
Geocodes a query and returns the single best-matching place.

It wraps geocode and returns the top result directly.
Parameters
- queryOrParams: string | Omit<GeocodingParams, "limit">
  The address or place name to geocode, or the full GeocodingParams without limit.
Returns Promise<Place<GeocodingProps>>
The best-matching place.
Throws
If no results are found for the query

Remarks
To handle finding no results without throwing, use geocode with a limit parameter.
Example
```
const place = await geocodeOne('Amsterdam Centraal');
console.log(place.geometry.coordinates); // [lng, lat]

const biased = await geocodeOne({ query: 'Main Street', geoBias: { position: [4.9041, 52.3676] }, signal });
```