Typings入門

Typingsとは?

TypeScriptの型定義ファイルを管理するツールです。
https://github.com/typings/typings

Typingsの導入

npmで取得します(globalでいいと思います)。

npm install -g typings

Typingsの使い方

初期化

Typingsではtypings.jsonで利用する型定義ファイルを管理します。
プロジェクトのディレクトリに作成したいので、プロジェクトのディレクトリで下記コマンドを実行しましょう。

typings init

これでプロジェクトのディレクトリにtypings.jsonが作成されます。

{
  "dependencies": {}
}

まだ空です。

型定義ファイルの検索

型定義ファイルを検索する場合は下記コマンドを実行します。
主要なJSライブラリなら大体型定義ファイルが見つかります。

typings seach jquery

型定義ファイルの取得

下記コマンドで型定義ファイルを取得できます。
プロジェクトディレクトリ配下にtypings/globalディレクトリが作成され、そこに指定した型定義ファイルが追加されます。

typings install dt~jquery --global --save

また、typings.jsonに取得した定義ファイルの情報が追加されます。

typings.json

{
  "dependencies": {},
  "globalDependencies": {
    "jquery": "registry:dt/jquery#1.10.0+20170310222111"
  }
}

型定義ファイルの利用

projectRoot/typings/index.d.tsを参照すればtypingsで取得した型定義ファイルを全て参照することが出来ます。

f:id:mt9116:20171206095705p:plain

f:id:mt9116:20171206095652p:plain

型定義ファイルの削除

下記コマンドで型定義ファイルを削除することが出来ます。

typings remove jquery --global --save

最後に

TypeScriptは型定義ファイルを利用することでその真価が発揮されます。
Typingsで型定義ファイルを活用してみてください。