TypeScript i Mapy Google

TypeScript to typowany nadzbiór języka JavaScript, który kompiluje się do zwykłego JavaScriptu. Poniższy przykładowy kod pokazuje proste użycie Map Google za pomocą 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>
Zobacz przykład

Rozpocznij

Projekt DefinitelyTyped to projekt open source, który obsługuje pliki deklaracji typów dla wielu pakietów, w tym Map Google. Użyj NPM, aby zainstalować pliki deklaracji JavaScriptu Map Google z pakietu @types/google.maps:

npm i -D @types/google.maps

Więcej informacji znajdziesz w plikach źródłowych na GitHubie.

Dodaj google.maps do opcji tsconfig types

Jeśli plik tsconfig ustawia opcję kompilatora types, TypeScript uwzględnia tylko pakiety @types wymienione w tej tablicy. Zainstalowanie @types/google.maps nie wystarczy, aby włączyć obsługę TypeScript w Mapach Google, a kod, który używa przestrzeni nazw google, nie kompiluje się i powoduje błąd:

Error T2503: Cannot find namespace 'google'.

Aby dodać google.maps do tablicy types:

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

Możesz też dodać tę dyrektywę do pliku deklaracji, który zawiera Twój projekt, np. vite-env.d.ts:

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

Więcej informacji znajdziesz w sekcji Typy.

Konfliktujące pakiety @types

Niektóre biblioteki mogą używać pakietu innego niż @types/google.maps, co może powodować konflikty. Aby uniknąć problemów z niespójnymi typami, użyj opcji kompilatora skipLibCheck:

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

Określanie typeRoots

Niektóre platformy, takie jak Angular, mogą wymagać określenia opcji kompilatora typeRoots, aby uwzględnić typy zainstalowane z @types/google.maps i wszystkich innych pakietów @types.

Domyślnie wszystkie widoczne pakiety @types są uwzględniane w kompilacji. Pakiety w node_modules/@types dowolnego folderu nadrzędnego są uznawane za widoczne:

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