Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gojob-1337/node-google-place
A small node module to use Google Place API written in typescript
https://github.com/gojob-1337/node-google-place
Last synced: 3 days ago
JSON representation
A small node module to use Google Place API written in typescript
- Host: GitHub
- URL: https://github.com/gojob-1337/node-google-place
- Owner: gojob-1337
- Created: 2018-03-13T14:49:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-20T08:56:26.000Z (over 1 year ago)
- Last Synced: 2024-10-29T16:25:10.602Z (10 days ago)
- Language: TypeScript
- Size: 85.9 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# @gojob/google-place
[](https://travis-ci.org/gojob-1337/node-google-place)
[](https://coveralls.io/github/gojob-1337/node-google-place?branch=master)
## Description
This package is a library for Node.js to consume the Google Place autocomplete & details API.
It returns a small subset of their data.
## Installation
```
yarn add @gojob/google-place
```
## Usage
```typescript
import * as gp from '@gojob/google-place';
```
### Autocomplete API
```typescript
const results = await gp.autocomplete({
key: 'YOUR_API_KEY',
input: 'Port-de-Bouc',
language: 'fr',
countries: ['fr'],
});
```
#### gp.autocomplete(`query`)
| Name | Type | Description |
|:--------:|:------:|:-------------------------------------------------------------------------------------------------------|
| key | string | Google API Key |
| input | string | Searched entry |
| language | string | Language to use (optional) [Google Code](https://developers.google.com/maps/faq?hl=fr#languagesupport) |
| countries | string[] | Filter on a country (optional) [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) |
Returns a list of prediction or throw if an error occurred.
```typescript
interface IPrediction {
id: string;
name: string;
}
```
As:
| Name | Type | Description |
|:----:|:------:|:------------|
| id | string | Place id |
| name | string | Place name |
#### gp.retrieve(`query`)
```typescript
const place = gp.retrieve({
key: 'YOUR_API_KEY',
id: 'ChIJ-RzUxt8ethIRksIaOl-0tJY',
language: 'fr',
});
```
As:
| Name | Type | Description |
|:--------:|:------:|:-------------------------------------------------------------------------------------------------------|
| key | string | Google API Key |
| id | string | Searched entry |
| language | string | Language to use (optional) [Google Code](https://developers.google.com/maps/faq?hl=fr#languagesupport) |
Returns a place or throw if an error occurred.
```typescript
export interface ILocation {
lat: number;
lng: number;
}
export interface IPlace {
id: string;
address: string;
location: ILocation;
postalCode: string;
locality: string;
administrativeAreaLevel1: string;
administrativeAreaLevel2: string;
countryCode: string;
country: string;
}
```
As:
| Name | Type | Description |
|:------------------------:|:------:|:-------------------------------------------------|
| id | string | Place id |
| address | string | Formatted address |
| location | object | Latitude and longitude coordinates |
| postalCode | string | Postal code |
| locality | string | Locality name (long or short name) |
| administrativeAreaLevel1 | string | Administrative Area Level 1 (long or short name) |
| administrativeAreaLevel2 | string | Administrative Area Level 2 (long or short name) |
| countryCode | string | Country short name |
| stateCode | string | Administrative Area Level 1 (short name) |
| country | string | Country name (long name) |
_postalCode, administrativeAreaLevel1 or administrativeAreaLevel2 may be empty string_
#### gp.reverseGeocode(opts)
```typescript
const place = gp.reverseGeocode({
key: 'YOUR_API_KEY',
latlng: 'XXX,YYY',
language: 'fr',
});
```
As:
| Name | Type | Description |
|:--------:|:------:|:-------------------------------------------------------------------------------------------------------|
| key | string | Google API Key |
| latlng | string | Latitude and longitude coordinates (coma separated) |
| language | string | Language to use (optional) [Google Code](https://developers.google.com/maps/faq?hl=fr#languagesupport) |
Find an address from a location coordinates. Returns a `IPlace`.