TypeScript و Google Maps

TypeScript یک اَبَرمجموعه تایپ‌شده از جاوا اسکریپت است که به جاوا اسکریپت ساده کامپایل می‌شود. کد نمونه زیر نحوه استفاده ساده از Google Maps با 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>
مشاهده نمونه

شروع کنید

پروژه DefinitelyTyped پروژه‌ای متن‌باز است که فایل‌های اعلان نوع را برای بسیاری از بسته‌ها ازجمله Google Maps نگهداری می‌کند. از NPM برای نصب فایل‌های اعلامیه جاوا اسکریپت Google Maps از بسته @types/google.maps استفاده کنید:

npm i -D @types/google.maps

برای اطلاعات بیشتر، فایل‌های منبع را در GitHub ببینید.

google.maps را به گزینه tsconfig types اضافه کنید

اگر فایل tsconfig شما گزینه کامپایلر types را تنظیم کند، TypeScript فقط بسته‌های @types فهرست‌شده در آن آرایه را دربرمی‌گیرد. نصب @types/google.maps برای فعال کردن پشتیبانی TypeScript برای Google Maps کافی نیست و کدی که از فضای نام google استفاده می‌کند با خطای زیر کامپایل نمی‌شود:

Error T2503: Cannot find namespace 'google'.

برای افزودن google.maps به آرایه types:

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

یا اینکه دستورالعمل زیر را به فایل اظهارنامه‌ای که پروژه شما شامل می‌شود، مانند vite-env.d.ts، اضافه کنید:

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

برای اطلاعات بیشتر، به انواع مراجعه کنید.

بسته‌های types @متناقض

برخی‌از کتابخانه‌ها ممکن است از بسته‌ای غیراز @types/google.maps استفاده کنند، که ممکن است باعث تداخل شود. از گزینه کامپایلر skipLibCheck استفاده کنید تا از بروز مشکل با انواع ناسازگار جلوگیری شود:

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

مشخص کردن typeRoots

برخی چارچوب‌ها مانند Angular ممکن است نیاز به تعیین گزینه کامپایلر typeRoots داشته باشند تا انواع نصب‌شده از @types/google.maps و همه بسته‌های @types دیگر را شامل شوند.

به‌طور پیش‌فرض، همه بسته‌های @types نمایان در گردآوری شما گنجانده می‌شوند. بسته‌های موجود در node_modules/@types هر پوشه دربرگیرنده، نمایان درنظر گرفته می‌شوند:

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