Class Loader

[[Loader]] makes it easier to add Google Maps JavaScript API to your application dynamically using Promises. It works by dynamically creating and appending a script node to the the document head and wrapping the callback function so as to return a promise.

const loader = new Loader({
  apiKey: "",
  version: "weekly",
  libraries: ["places"]
});

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

Constructors

constructor

Properties

apiKey authReferrerPolicy channel client id language libraries mapIds nonce region retries url version

Accessors

options status

Methods

deleteScript importLibrary load loadCallback

Constructors

constructor

  • new Loader(__namedParameters: LoaderOptions): Loader

  • Creates an instance of Loader using [[LoaderOptions]]. No defaults are set using this library, instead the defaults are set by the Google Maps JavaScript API server.

    const loader = Loader({apiKey, version: 'weekly', libraries: ['places']});

    Parameters

    Returns Loader

Properties

ReadonlyapiKey

apiKey: string

See [[LoaderOptions.apiKey]]

ReadonlyauthReferrerPolicy

authReferrerPolicy: "origin"

See [[LoaderOptions.authReferrerPolicy]]

Readonlychannel

channel: string

See [[LoaderOptions.channel]]

Readonlyclient

client: string

See [[LoaderOptions.client]]

Readonlyid

id: string

See [[LoaderOptions.id]]

Readonlylanguage

language: string

See [[LoaderOptions.language]]

Readonlylibraries

libraries: Libraries

See [[LoaderOptions.libraries]]

ReadonlymapIds

mapIds: string[]

See [[LoaderOptions.mapIds]]

Readonlynonce

nonce: string

See [[LoaderOptions.nonce]]

Readonlyregion

region: string

See [[LoaderOptions.region]]

Readonlyretries

retries: number

See [[LoaderOptions.retries]]

Readonlyurl

url: string

See [[LoaderOptions.url]]

Readonlyversion

version: string

See [[LoaderOptions.version]]

Accessors

options

status

Methods

deleteScript

importLibrary

load

  • load(): Promise<typeof google>

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

    Returns Promise<typeof google>

loadCallback

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

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

    Parameters

    • fn: (e: ErrorEvent) => void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods