Skip to content

docs(README): add note about @types/google.maps #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 23, 2022
Merged

docs(README): add note about @types/google.maps #565

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ Available via npm as the package [@googlemaps/js-api-loader](https://www.npmjs.c
npm i @googlemaps/js-api-loader
```

or

```sh
yarn add @googlemaps/js-api-loader
```

Alternatively you may add the umd package directly to the html document using the unpkg link.

```html
Expand All @@ -33,6 +27,14 @@ Alternatively you may add the umd package directly to the html document using th

When adding via unpkg, the loader can be accessed at `google.maps.plugins.loader.Loader`.

### TypeScript

TypeScript users need to install the following types package.

```sh
npm i -D @types/google.maps
```

## Documentation

The reference documentation can be found at this [link](https://googlemaps.github.io/js-api-loader/index.html). The Google Maps JavaScript API [documentation](https://developers.google.com/maps/documentation/javascript/tutorial) is the authoritative source for the loader options.
Expand Down