TypeScript e Google Maps

O TypeScript é um superconjunto de JavaScript com tipagem que é compilado em JavaScript simples. O exemplo de código abaixo demonstra o uso simples do Google Maps com 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>
Exemplo

Primeiros passos

O projeto DefinitelyTyped é um projeto de código aberto que mantém arquivos de declaração de tipo de muitos pacotes, incluindo o Google Maps. Use o NPM para instalar os arquivos de declaração do JavaScript do Google Maps do pacote @types/google.maps:

npm i -D @types/google.maps

Para mais informações, consulte os arquivos de origem no GitHub.

Adicione google.maps à opção tsconfig types

Se o arquivo tsconfig definir a opção de compilador types, o TypeScript vai incluir apenas os pacotes @types listados nessa matriz. Instalar o @types/google.maps não é suficiente para ativar o suporte ao TypeScript para o Google Maps, e o código que usa o namespace google não é compilado com o seguinte erro:

Error T2503: Cannot find namespace 'google'.

Para adicionar google.maps à matriz types:

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

Como alternativa, adicione a seguinte diretiva a um arquivo de declaração que seu projeto inclui, como vite-env.d.ts:

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

Para mais informações, consulte tipos.

Pacotes de @types conflitantes

Algumas bibliotecas talvez usem um pacote diferente de @types/google.maps, o que pode causar conflitos. Utilize a opção do compilador skipLibCheck para evitar problemas com tipos inconsistentes:

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

Especificar typeRoots

Alguns frameworks, como o Angular, podem exigir a especificação da opção do compilador typeRoots para incluir tipos instalados de @types/google.maps e todos os outros pacotes @types.

Por padrão, todos os pacotes @types visíveis estão incluídos na sua compilação. Os pacotes em node_modules/@types de qualquer pasta delimitada são considerados visíveis:

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