@googlemaps/url-signature
TypeScript icon, indicating that this package has built-in type declarations

1.0.33 • Public • Published

Google Maps JavaScript URL Signing

npm Build Release codecov GitHub contributors semantic-release

Description

Sign a URL for Google Maps Platform requests.

Warning: It is not recommended to use this library in client side applications to avoid exposing the secret used to sign the URL.

Install

Available via npm as the package @googlemaps/url-signature.

npm i @googlemaps/url-signature

Documentation

Check out the reference documentation.

Example

Create a signature for a Google Maps request URL or url string.

const signature = createSignature("https://example.com/some-path?foo=bar", "secret");

Returns a new URL having a signature parameter.

const signedUrl = signUrl("https://example.com/some-path?foo=bar", "secret");
signedUrl.href; // "https://example.com/some-path?foo=bar&signature=..."

Create a signature for a path and query string using Hmac SHA1.

const signature = createSignatureForPathAndQuery("/some-path?foo=bar", "secret");

Note: This is not an officially supported Google product

Readme

Keywords

Package Sidebar

Install

npm i @googlemaps/url-signature

Weekly Downloads

224,843

Version

1.0.33

License

Apache-2.0

Unpacked Size

33.7 kB

Total Files

11

Last publish

Collaborators

  • wangela
  • google-wombot