npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gojob/google-place

v1.8.0

Published

A small node module to use the Google Place API written in typescript

Downloads

3,361

Readme

@gojob/google-place

travis build Coverage Status

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

import * as gp from '@gojob/google-place';

Autocomplete API

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 | | countries | string[] | Filter on a country (optional) ISO 3166-1 Alpha-2 |

Returns a list of prediction or throw if an error occurred.

interface IPrediction {
  id: string;
  name: string;
}

As:

| Name | Type | Description | |:----:|:------:|:------------| | id | string | Place id | | name | string | Place name |

gp.retrieve(query)

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 |

Returns a place or throw if an error occurred.

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)

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 |

Find an address from a location coordinates. Returns a IPlace.