TypeScript и Google Карты

TypeScript – это расширенная типизированная версия JavaScript. TypeScript компилируется в обычный JavaScript. В примере кода ниже показано, как использовать Google Карты с TypeScript.

TypeScript

async function init(): Promise<void> {
    // Import the needed libraries.
    await google.maps.importLibrary('maps');

    // Access the map.
    const mapElement = document.querySelector('gmp-map')!;
    // Access the underlying map object.
    const innerMap = mapElement.innerMap;

    console.log({ mapElement, innerMap });
}

void init();

JavaScript

async function init() {
    // Import the needed libraries.
    await google.maps.importLibrary('maps');

    // Access the map.
    const mapElement = document.querySelector('gmp-map');
    // Access the underlying map object.
    const innerMap = mapElement.innerMap;

    console.log({ mapElement, innerMap });
}

void init();

CSS

/* 
 * Optional: Makes the sample page fill the window. 
 */
html,
body {
    height: 100%;
    margin: 0;
    padding: 0;
}

HTML

<html>
    <head>
        <title>Simple Map</title>

        <link rel="stylesheet" type="text/css" href="./style.css" />
        <script type="module" src="./index.js"></script>
        <script>
            // prettier-ignore
            (g=>{var h,a,k,p="The Google Maps JavaScript API",c="google",l="importLibrary",q="__ib__",m=document,b=window;b=b[c]||(b[c]={});var d=b.maps||(b.maps={}),r=new Set,e=new URLSearchParams,u=()=>h||(h=new Promise(async(f,n)=>{await (a=m.createElement("script"));e.set("libraries",[...r]+"");for(k in g)e.set(k.replace(/[A-Z]/g,t=>"_"+t[0].toLowerCase()),g[k]);e.set("callback",c+".maps."+q);a.src=`https://maps.${c}apis.com/maps/api/js?`+e;d[q]=f;a.onerror=()=>h=n(Error(p+" could not load."));a.nonce=m.querySelector("script[nonce]")?.nonce||"";m.head.append(a)}));d[l]?console.warn(p+" only loads once. Ignoring:",g):d[l]=(f,...n)=>r.add(f)&&u().then(()=>d[l](f,...n))})({
                key: "GOOGLE_MAPS_API_KEY"
            });
        </script>
    </head>

    <body>
        <gmp-map center="-34.397,150.644" zoom="8" map-id="DEMO_MAP_ID">
        </gmp-map>
    </body>
</html>
Посмотреть пример

Начать

DefinitelyTyped – это библиотека с открытым исходным кодом, которая поддерживает файлы объявлений типов для многих пакетов, включая Google Карты. Установите файлы объявлений Google Maps JavaScript из пакета @types/google.maps с помощью npm:

npm i -D @types/google.maps

Дополнительную информацию можно найти в исходных файлах на GitHub.

Добавить google.maps в вариант types (tsconfig)

Если в файле tsconfig задан параметр компилятора types, TypeScript включает только пакеты @types, перечисленные в этом массиве. Установки @types/google.maps недостаточно, чтобы включить поддержку TypeScript для Google Карт. Код, в котором используется пространство имен google, не компилируется, и появляется следующая ошибка:

Error T2503: Cannot find namespace 'google'.

Чтобы добавить google.maps в массив types, выполните следующие действия:

{
  "compilerOptions": {
    "types": ["google.maps"]
  }
}

Вы также можете добавить следующую директиву в файл объявления, который включен в ваш проект, например vite-env.d.ts:

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

Подробнее о типах…

Пакеты, конфликтующие с @types

Использование в некоторых библиотеках пакетов, отличных от @types/google.maps, может вызывать конфликты. Чтобы избежать их, применяйте параметр компилятора skipLibCheck.

{
  "compilerOptions": {
    "skipLibCheck": true
  }
}

Как задать typeRoots

Некоторым фреймворкам, таким как Angular, для работы с типами, установленными из @types/google.maps, и любыми другими пакетами @types может требоваться заданный параметр компилятора typeRoots.

По умолчанию все видимые пакеты @types включаются в вашу компиляцию. Пакеты в node_modules/@types любой вложенной папки считаются видимыми:

{
  "compilerOptions": {
    "typeRoots": [
      "node_modules/@types"
    ]
  }
}