TypeScript et Google Maps

TypeScript est un sur-ensemble typé de JavaScript compilé vers du JavaScript simple. L'exemple de code ci-dessous illustre une utilisation simple de Google Maps avec 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>
Voir un exemple

Commencer

Le projet DefinitelyTyped est un projet Open Source qui gère les fichiers de déclaration de type pour de nombreux packages, y compris Google Maps. Utilisez NPM pour installer les fichiers de déclaration JavaScript Google Maps à partir du package @types/google.maps :

npm i -D @types/google.maps

Pour en savoir plus, consultez les fichiers sources sur GitHub.

Ajoutez google.maps à l'option tsconfig types.

Si votre fichier tsconfig définit l'option de compilateur types, TypeScript n'inclut que les packages @types listés dans ce tableau. L'installation de @types/google.maps ne suffit pas pour activer la compatibilité avec TypeScript pour Google Maps, et le code qui utilise l'espace de noms google ne se compile pas avec l'erreur suivante :

Error T2503: Cannot find namespace 'google'.

Pour ajouter google.maps au tableau types :

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

Vous pouvez également ajouter la directive suivante à un fichier de déclaration inclus dans votre projet, tel que vite-env.d.ts :

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

Pour en savoir plus, consultez Types.

Packages @types en conflit

Certaines bibliothèques peuvent utiliser un package autre que @types/google.maps, ce qui peut entraîner des conflits. Utilisez l'option de compilateur skipLibCheck pour éviter les problèmes de types incohérents :

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

Spécifier typeRoots

Avec certains frameworks tels qu'Angular, il peut être nécessaire de spécifier l'option de compilateur typeRoots pour inclure les types installés à partir de @types/google.maps et tous les autres packages @types.

Par défaut, tous les packages @types visibles sont inclus dans votre compilation. Les packages dans node_modules/@types du dossier parent sont considérés comme visibles :

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