docs: add geocode example #454 (#734)

BaljeetSinghaw · Jul 13, 2024 · 5d0328a · 5d0328a
1 parent 3588e2f
commit 5d0328a
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -206,6 +206,25 @@ export class Client {
   geolocate(request: GeolocateRequest): Promise<GeolocateResponse> {
     return geolocate(request, this.axiosInstance);
   }
+  /**
+   * An example use of this function.
+   *
+   * ```javascript
+   * import { Client } from '@googlemaps/google-maps-services-js';
+   * 
+   * const args = {
+   *   params: {
+   *     key: '<your-api-key>',
+   *     address: 'Perth 4WD & Commercial Centre',
+   *   }
+   * };
+   * const client = new Client();
+   * client.geocode(args).then(gcResponse => {
+   *   const str = JSON.stringify(gcResponse.data.results[0]);
+   *   console.log(`First result is: ${str}`);)
+   * });
+   * ```
+   */
   geocode(request: GeocodeRequest): Promise<GeocodeResponse> {
     return geocode(request, this.axiosInstance);
   }