TypeScript 和 Google 地圖

TypeScript 是 JavaScript 類型化超集合,可編譯為純 JavaScript。以下程式碼片段示範採用 TypeScript 的 Google 地圖簡易用法。

let map: google.maps.Map;
const center: google.maps.LatLngLiteral = {lat: 30, lng: -110};

function initMap(): void {
  map = new google.maps.Map(document.getElementById("map") as HTMLElement, {
    center,
    zoom: 8
  });
}

開始使用

DefinitelyTyped 專案是一項開放原始碼專案,可維護許多套件 (包括 Google 地圖) 的類型宣告檔案。Google Maps JavaScript 宣告檔案 (請參閱 GitHub 上的來源檔案) 可透過 @types/google.maps 套件中的 NPM 安裝。

npm i -D @types/google.maps

Alpha 版和 Beta 版功能

類型通常沒有 Alpha 或 Beta 版中的屬性、函式或類別。在許多這類情況下,物件都能轉換為正確的類型。

下列錯誤是因 MapOptionsmapId Beta 版屬性所導致。

error TS2345: Argument of type '{ center: google.maps.LatLng; zoom: number;
mapId: string; }' is not assignable to parameter of type 'MapOptions'. Object
literal may only specify known properties, and 'mapId' does not exist in type
'MapOptions'.

上述錯誤可以使用下方的轉換進行修正。

{ center: {lat: 30, lng: -110}, zoom: 8, mapId: '1234' } as google.maps.MapOptions

@type 套件發生衝突

部分程式庫可能會使用 @types/google.maps 以外的套件,因此可能會造成衝突。請使用 skipLibCheck 編譯器選項來避免類型不一致的問題。

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

指定 typeRoots

某些架構 (例如 Angular) 可能需要指定 typeRoots 編譯器選項,以便納入從 @types/google.maps 和所有其他「@types」套件安裝的類型。

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