diff --git a/packages/arcgis-rest-geocoder/README.md b/packages/arcgis-rest-geocoder/README.md index c61ae3b4e1..e095db680c 100644 --- a/packages/arcgis-rest-geocoder/README.md +++ b/packages/arcgis-rest-geocoder/README.md @@ -23,12 +23,21 @@ import { geocode } from '@esri/arcgis-rest-geocoder'; geocode("LAX") .then((response) => { - response.candidates[0].location; // => { x: -118.409, y: 33.943, spatialReference: { wkid: 4326 } } + response.candidates[0].location; + // => { x: -118.409, y: 33.943 } }); ``` ### [API Reference](https://esri.github.io/arcgis-rest-js/api/geocoder/) +* [`geocode("1 World Way Los Angeles 90045")`](https://esri.github.io/arcgis-rest-js/api/geocoder/geocode/) + +* [`suggest("Starb")`](https://esri.github.io/arcgis-rest-js/api/geocoder/suggest/) + +* [`reverseGeocode([-118.409,33.943 ])`](https://esri.github.io/arcgis-rest-js/api/geocoder/reverseGeocode/) + +* [`bulkGeocode()`](https://esri.github.io/arcgis-rest-js/api/geocoder/bulkGeocode/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-geocoder/src/helpers.ts b/packages/arcgis-rest-geocoder/src/helpers.ts index 22c2950921..1726f4f7b1 100644 --- a/packages/arcgis-rest-geocoder/src/helpers.ts +++ b/packages/arcgis-rest-geocoder/src/helpers.ts @@ -62,7 +62,7 @@ export function getGeocodeService( } /** - * Deprecated. Please use `getGeocodeService()` instead. + * Deprecated. Please use [`getGeocodeService()`](../getGeocodeService/) instead. * * @param requestOptions - Request options can contain a custom geocoding service to fetch metadata from. * @returns A Promise that will resolve with the data from the response.