diff --git a/index.html b/index.html index e389308c..ca51a478 100644 --- a/index.html +++ b/index.html @@ -14,6 +14,9 @@

Google Maps JavaScript URL Signing

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

diff --git a/modules.html b/modules.html index df32cb2f..a2feea7f 100644 --- a/modules.html +++ b/modules.html @@ -1,4 +1,4 @@ -@googlemaps/url-signature

@googlemaps/url-signature

Index

Functions

createSignature

  • createSignature(unsignedUrl: string | URL, secret: string): string
  • +@googlemaps/url-signature
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @googlemaps/url-signature

    Index

    Functions

    createSignature

    • createSignature(unsignedUrl: string | URL, secret: string): string
    • Create a signature for a Google Maps request URL or url string.

      const signature = createSignature("https://example.com/some-path?foo=bar", "secret");
       
      @@ -7,14 +7,14 @@
    • secret: string

      The secret to use for signing.

    Returns string

    The signature of the signed url.

    -

createSignatureForPathAndQuery

  • createSignatureForPathAndQuery(pathAndQuery: string, secret: string): string

createSignatureForPathAndQuery

  • createSignatureForPathAndQuery(pathAndQuery: string, secret: string): string
  • Create a signature for a path and query string using HmacSHA1.

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

    Parameters

    • pathAndQuery: string
    • secret: string

      The secret to use for signing.

    Returns string

    The signature of the signed url.

    -

signUrl

  • signUrl(unsignedUrl: string | URL, secret: string): URL

signUrl

  • signUrl(unsignedUrl: string | URL, secret: string): URL
  • 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=..."