@types/load-google-maps-api NPM

Installation

npm install --save @types/load-google-maps-api

Summary

This package contains type definitions for load-google-maps-api (https://github.com/yuanqing/load-google-maps-api#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/load-google-maps-api.

index.d.ts

// Type definitions for load-google-maps-api 2.0
// Project: https://github.com/yuanqing/load-google-maps-api#readme
// Definitions by: Oscar Busk <https://github.com/oBusk>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0

/// <reference types="google.maps" />

interface Options {
    /**
     * The Google Maps API `script` tag URL
     *
     * Default Value `'https://maps.googleapis.com/maps/api/js'`
     */
    apiUrl?: string | undefined;
    /**
     * Client usage reporting channel
     *
     * https://developers.google.com/maps/premium/reports/usage-reports#channels
     */
    channel?: string | undefined;
    /**
     * Client ID
     *
     * https://developers.google.com/maps/documentation/javascript/get-api-key#specifying-a-client-id-when-loading-the-api
     */
    client?: string | undefined;
    /**
     * Your API key
     *
     * https://developers.google.com/maps/documentation/javascript/get-api-key#step-2-add-the-api-key-to-your-application
     */
    key?: string | undefined;
    /**
     * https://developers.google.com/maps/documentation/javascript/localization#Language
     */
    language?: string | undefined;
    /**
     * Supplemental libraries to load
     *
     * Default Value `[]`
     *
     * https://developers.google.com/maps/documentation/javascript/libraries
     */
    libraries?: string[] | undefined;
    /**
     * https://developers.google.com/maps/documentation/javascript/localization#Region
     */
    region?: string | undefined;
    /**
     * Time in milliseconds before rejecting the Promise
     *
     * Default Value `10000`
     */
    timeout?: number | undefined;
    /**
     * API Version
     *
     * https://developers.google.com/maps/documentation/javascript/versions
     */
    v?: string | undefined;
}

declare function loadGoogleMapsApi(options?: Options): Promise<typeof google.maps>;

export = loadGoogleMapsApi;