TypingsでTypeScriptの型定義ファイルを管理する

TypeScript
スポンサーリンク

Typings とは?

TypeScript の型定義ファイルを管理するツールです。

GitHub - typings/typings: *DEPRECATED* The TypeScript Definition Manager
*DEPRECATED* The TypeScript Definition Manager. Contribute to typings/typings development by creating an account on GitHub.

Typingsの導入

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

npm install -g typings

Typingsの使い方

初期化

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

typings init

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

{
  "dependencies": {}
}

まだ空です。

型定義ファイルの検索

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

typings seach jquery

型定義ファイルの取得

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

typings install dt~jquery --global --save

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

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

型定義ファイルの利用

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

型定義ファイルの削除

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

typings remove jquery --global --save

最後に

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

タイトルとURLをコピーしました