TypeScript dan Google Maps

TypeScript adalah superset JavaScript hasil ketikan yang dikompilasi menjadi JavaScript biasa. Kode contoh di bawah menunjukkan penggunaan sederhana Google Maps menggunakan 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>
Lihat contoh

Mulai

Project DefinitelyTyped adalah project open source yang mengelola file deklarasi type untuk banyak paket, termasuk Google Maps. Gunakan NPM untuk menginstal file deklarasi JavaScript Google Maps dari paket @types/google.maps:

npm i -D @types/google.maps

Untuk mengetahui informasi selengkapnya, lihat file sumber di GitHub.

Menambahkan google.maps ke opsi tsconfig types

Jika file tsconfig Anda menetapkan opsi compiler types, TypeScript hanya akan menyertakan paket @types yang tercantum dalam array tersebut. Menginstal @types/google.maps tidak cukup untuk mengaktifkan dukungan TypeScript untuk Google Maps, dan kode yang menggunakan namespace google gagal dikompilasi dengan error berikut:

Error T2503: Cannot find namespace 'google'.

Untuk menambahkan google.maps ke array types:

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

Atau, tambahkan perintah berikut ke file deklarasi yang disertakan project Anda, seperti vite-env.d.ts:

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

Untuk mengetahui informasi selengkapnya, lihat jenis.

Paket @types yang bertentangan

Beberapa library mungkin menggunakan paket selain @types/google.maps, yang dapat menyebabkan konflik. Gunakan opsi compiler skipLibCheck untuk menghindari masalah terkait type yang tidak konsisten:

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

Menentukan typeRoots

Beberapa framework seperti Angular mungkin perlu menentukan opsi compiler typeRoots untuk menyertakan type yang diinstal dari @types/google.maps dan semua paket @types lainnya.

Secara default, semua paket @types yang terlihat disertakan dalam kompilasi Anda. Paket dalam node_modules/@types dari folder apa pun yang tertutup dianggap terlihat:

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