From 9fdcf997a96cbc1cfa96ed94304f403442fae93b Mon Sep 17 00:00:00 2001 From: googlemaps-bot Date: Mon, 4 Nov 2024 08:15:59 +0000 Subject: [PATCH] chore(main): release 1.16.9 (#865) 66846f8b247509521ecfd5e0116243289c0c01b6 --- classes/Loader.html | 36 +++++++++++++++++------------------ enums/LoaderStatus.html | 4 ++-- interfaces/LoaderOptions.html | 28 +++++++++++++-------------- types/Libraries.html | 2 +- types/Library.html | 2 +- variables/DEFAULT_ID.html | 2 +- 6 files changed, 37 insertions(+), 37 deletions(-) diff --git a/classes/Loader.html b/classes/Loader.html index 7d94e3ec..e08adb21 100644 --- a/classes/Loader.html +++ b/classes/Loader.html @@ -6,7 +6,7 @@
const loader = new Loader({
apiKey: "",
version: "weekly",
libraries: ["places"]
});

loader.load().then((google) => {
const map = new google.maps.Map(...)
})
-

Constructors

Constructors

Properties

apiKey authReferrerPolicy channel @@ -32,22 +32,22 @@
const loader = Loader({apiKey, version: 'weekly', libraries: ['places']});
 
-

Parameters

Returns Loader

Properties

apiKey: string

See [[LoaderOptions.apiKey]]

-
authReferrerPolicy

See [[LoaderOptions.authReferrerPolicy]]

-
channel: string

See [[LoaderOptions.channel]]

-
client: string

See [[LoaderOptions.client]]

-
id: string
language: string

See [[LoaderOptions.language]]

-
libraries: Libraries

See [[LoaderOptions.libraries]]

-
mapIds: string[]

See [[LoaderOptions.mapIds]]

-
nonce: string

See [[LoaderOptions.nonce]]

-
region: string

See [[LoaderOptions.region]]

-
retries: number

See [[LoaderOptions.retries]]

-
url: string

See [[LoaderOptions.url]]

-
version: string

See [[LoaderOptions.version]]

-

Accessors

Methods

  • Parameters

    • name: "core"

    Returns Promise<CoreLibrary>

  • Parameters

    • name: "maps"

    Returns Promise<MapsLibrary>

  • Parameters

    • name: "places"

    Returns Promise<PlacesLibrary>

  • Parameters

    • name: "geocoding"

    Returns Promise<GeocodingLibrary>

  • Parameters

    • name: "routes"

    Returns Promise<RoutesLibrary>

  • Parameters

    • name: "marker"

    Returns Promise<MarkerLibrary>

  • Parameters

    • name: "geometry"

    Returns Promise<GeometryLibrary>

  • Parameters

    • name: "elevation"

    Returns Promise<ElevationLibrary>

  • Parameters

    • name: "streetView"

    Returns Promise<StreetViewLibrary>

  • Parameters

    • name: "journeySharing"

    Returns Promise<JourneySharingLibrary>

  • Parameters

    • name: "drawing"

    Returns Promise<DrawingLibrary>

  • Parameters

    • name: "visualization"

    Returns Promise<VisualizationLibrary>

  • Parameters

    Returns Promise<unknown>

  • Load the Google Maps JavaScript API script and return a Promise. +

    Parameters

    Returns Loader

Properties

apiKey: string

See [[LoaderOptions.apiKey]]

+
authReferrerPolicy

See [[LoaderOptions.authReferrerPolicy]]

+
channel: string

See [[LoaderOptions.channel]]

+
client: string

See [[LoaderOptions.client]]

+
id: string
language: string

See [[LoaderOptions.language]]

+
libraries: Libraries

See [[LoaderOptions.libraries]]

+
mapIds: string[]

See [[LoaderOptions.mapIds]]

+
nonce: string

See [[LoaderOptions.nonce]]

+
region: string

See [[LoaderOptions.region]]

+
retries: number

See [[LoaderOptions.retries]]

+
url: string

See [[LoaderOptions.url]]

+
version: string

See [[LoaderOptions.version]]

+

Accessors

Methods

  • Parameters

    • name: "core"

    Returns Promise<CoreLibrary>

  • Parameters

    • name: "maps"

    Returns Promise<MapsLibrary>

  • Parameters

    • name: "places"

    Returns Promise<PlacesLibrary>

  • Parameters

    • name: "geocoding"

    Returns Promise<GeocodingLibrary>

  • Parameters

    • name: "routes"

    Returns Promise<RoutesLibrary>

  • Parameters

    • name: "marker"

    Returns Promise<MarkerLibrary>

  • Parameters

    • name: "geometry"

    Returns Promise<GeometryLibrary>

  • Parameters

    • name: "elevation"

    Returns Promise<ElevationLibrary>

  • Parameters

    • name: "streetView"

    Returns Promise<StreetViewLibrary>

  • Parameters

    • name: "journeySharing"

    Returns Promise<JourneySharingLibrary>

  • Parameters

    • name: "drawing"

    Returns Promise<DrawingLibrary>

  • Parameters

    • name: "visualization"

    Returns Promise<VisualizationLibrary>

  • Parameters

    Returns Promise<unknown>

  • Load the Google Maps JavaScript API script and return a Promise. @deprecated, use importLibrary() instead.

    -

    Returns Promise<typeof google>

  • Load the Google Maps JavaScript API script with a callback. +

    Returns Promise<typeof google>

  • Load the Google Maps JavaScript API script with a callback. @deprecated, use importLibrary() instead.

    -

    Parameters

    • fn: ((e: ErrorEvent) => void)
        • (e): void
        • Parameters

          • e: ErrorEvent

          Returns void

    Returns void

+

Parameters

  • fn: ((e: ErrorEvent) => void)
      • (e): void
      • Parameters

        • e: ErrorEvent

        Returns void

Returns void

diff --git a/enums/LoaderStatus.html b/enums/LoaderStatus.html index 3984f535..232f58e1 100644 --- a/enums/LoaderStatus.html +++ b/enums/LoaderStatus.html @@ -1,6 +1,6 @@ LoaderStatus | @googlemaps/js-api-loader

The status of the [[Loader]].

-

Enumeration Members

Enumeration Members

Enumeration Members

FAILURE
INITIALIZED
LOADING
SUCCESS
+

Enumeration Members

FAILURE
INITIALIZED
LOADING
SUCCESS
diff --git a/interfaces/LoaderOptions.html b/interfaces/LoaderOptions.html index 9f073d37..9ff78419 100644 --- a/interfaces/LoaderOptions.html +++ b/interfaces/LoaderOptions.html @@ -3,7 +3,7 @@ is the authoritative source for [[LoaderOptions]]. /** Loader options

-
interface LoaderOptions {
    apiKey: string;
    authReferrerPolicy?: "origin";
    channel?: string;
    client?: string;
    id?: string;
    language?: string;
    libraries?: Libraries;
    mapIds?: string[];
    nonce?: string;
    region?: string;
    retries?: number;
    url?: string;
    version?: string;
}

Properties

interface LoaderOptions {
    apiKey: string;
    authReferrerPolicy?: "origin";
    channel?: string;
    client?: string;
    id?: string;
    language?: string;
    libraries?: Libraries;
    mapIds?: string[];
    nonce?: string;
    region?: string;
    retries?: number;
    url?: string;
    version?: string;
}

Properties

apiKey: string
authReferrerPolicy

Maps JS customers can configure HTTP Referrer Restrictions in the Cloud +

authReferrerPolicy

Maps JS customers can configure HTTP Referrer Restrictions in the Cloud Console to limit which URLs are allowed to use a particular API Key. By default, these restrictions can be configured to allow only certain paths to use an API Key. If any URL on the same domain or origin may use the API @@ -27,10 +27,10 @@ HTTP Referrer Restrictions are enabled on Cloud Console, Maps JavaScript API will only be able to load if there is an HTTP Referrer Restriction that matches the current website's domain without a path specified.

-
channel?: string
client?: string

See https://developers.google.com/maps/premium/overview, use apiKey instead.

-
id?: string

The id of the script tag. Before adding a new script, the Loader will check for an existing one.

-
language?: string

By default, the Maps JavaScript API uses the user's preferred language +

channel?: string
client?: string

See https://developers.google.com/maps/premium/overview, use apiKey instead.

+
id?: string

The id of the script tag. Before adding a new script, the Loader will check for an existing one.

+
language?: string

By default, the Maps JavaScript API uses the user's preferred language setting as specified in the browser, when displaying textual information such as the names for controls, copyright notices, driving directions and labels on maps. In most cases, it's preferable to respect the browser @@ -44,7 +44,7 @@

See the list of supported languages. Note that new languages are added often, so this list may not be exhaustive.

-
libraries?: Libraries

When loading the Maps JavaScript API via the URL you may optionally load +

libraries?: Libraries

When loading the Maps JavaScript API via the URL you may optionally load additional libraries through use of the libraries URL parameter. Libraries are modules of code that provide additional functionality to the main Maps JavaScript API but are not loaded unless you specifically request them.

@@ -52,9 +52,9 @@

Set the list of libraries for more options.

-
mapIds?: string[]

Passing mapIds is no longer required in the script tag.

-
nonce?: string

Use a cryptographic nonce attribute.

-
region?: string

When you load the Maps JavaScript API from maps.googleapis.com it applies a +

mapIds?: string[]

Passing mapIds is no longer required in the script tag.

+
nonce?: string

Use a cryptographic nonce attribute.

+
region?: string

When you load the Maps JavaScript API from maps.googleapis.com it applies a default bias for application behavior towards the United States. If you want to alter your application to serve different map tiles or bias the application (such as biasing geocoding results towards the region), you can @@ -70,9 +70,9 @@

const loader = Loader({apiKey, region: 'GB'});
 
-
retries?: number

The number of script load retries.

-
url?: string

Use a custom url and path to load the Google Maps API script.

-
version?: string

In your application you can specify release channels or version numbers:

+
retries?: number

The number of script load retries.

+
url?: string

Use a custom url and path to load the Google Maps API script.

+
version?: string

In your application you can specify release channels or version numbers:

The weekly version is specified with version=weekly. This version is updated once per week, and is the most current.

const loader = Loader({apiKey, version: 'weekly'});
@@ -91,4 +91,4 @@
 
 

If you do not explicitly specify a version, you will receive the weekly version by default.

-
+
diff --git a/types/Libraries.html b/types/Libraries.html index 223da5f9..d30b8d8b 100644 --- a/types/Libraries.html +++ b/types/Libraries.html @@ -1 +1 @@ -Libraries | @googlemaps/js-api-loader
Libraries: Library[]
+Libraries | @googlemaps/js-api-loader
Libraries: Library[]
diff --git a/types/Library.html b/types/Library.html index 24c18643..183660f3 100644 --- a/types/Library.html +++ b/types/Library.html @@ -1 +1 @@ -Library | @googlemaps/js-api-loader
Library:
    | "core"
    | "maps"
    | "places"
    | "geocoding"
    | "routes"
    | "marker"
    | "geometry"
    | "elevation"
    | "streetView"
    | "journeySharing"
    | "drawing"
    | "visualization"
+Library | @googlemaps/js-api-loader
Library:
    | "core"
    | "maps"
    | "places"
    | "geocoding"
    | "routes"
    | "marker"
    | "geometry"
    | "elevation"
    | "streetView"
    | "journeySharing"
    | "drawing"
    | "visualization"
diff --git a/variables/DEFAULT_ID.html b/variables/DEFAULT_ID.html index 6b0dcac3..e84b1395 100644 --- a/variables/DEFAULT_ID.html +++ b/variables/DEFAULT_ID.html @@ -1 +1 @@ -DEFAULT_ID | @googlemaps/js-api-loader

Variable DEFAULT_IDConst

DEFAULT_ID = "__googleMapsScriptId"
+DEFAULT_ID | @googlemaps/js-api-loader

Variable DEFAULT_IDConst

DEFAULT_ID = "__googleMapsScriptId"