読者です 読者をやめる 読者になる 読者になる

TypeScriptの型定義ファイルのインストール方法

TypeScript

型定義ファイルのインストールについて

TypeScriptでは外部のライブラリを利用する場合には型定義ファイルをインストールして参照することで型情報を利用することができます。

この型定義ファイルのインストールは以下手の順で実行します。

前提条件

TypeScriptがnpmコマンドでインストールされていることとします。インストールされているかどうかわからない場合には以下のコマンドを実行しバージョン情報が取得できることを確認してください。

$ tsd --version

>> tsd 0.6.5

型情報のインストール

型情報はTypeScriptを実行するディレクトリへインストールします。インストール方法は以下の通りとなります。

1.インストールディレクトリへ移動する

インストールするディレクトリへ移動します。インストールディレクトリ以外に型情報をインストールした場合には型情報を参照できないため、忘れずに移動してください。

# ~/path/to/ts で型定義ファイルをインストールするディレクトリへ移動する
$ cd ~/projects/girafa/web/src/main/resources/static/ts

2.インストール対象の型情報を検索する

インストールする対象の型情報が明確な場合には必要ないです、正確な情報がわからない場合には query コマンドにより型情報を検索します。

# 今回はmomentjsをインストールするため、momentを検索キーワードとして検索を実行する
$ tsd query moment --info          

 - moment / moment    
   >> Moment.js 2.8.0    : github.com/timrwood/moment
    @ Michael Lakerveld  : github.com/Lakerfield
    @ Aaron King         : github.com/kingdango
    @ Hiroki Horiuchi    : github.com/horiuchi
    @ Dick van den Brink : github.com/DickvdBrink
    @ Adi Dahiya         : github.com/adidahiya
    @ Matt Brooks        : github.com/EnableSoftware

この結果から、momentjsmomentが型情報の名称であることがわかります。なお、型情報の名称は対象のライブラリからjsを除いた物であることが多いらしい(未確認)。

3.型情報のインストール

対象となる型情報がわかったら型情報をインストールします。

$ tsd install moment --save --resolve

 - moment    / moment         
   -> moment > moment-node    

>> running install..

>> written 2 files:

    - moment/moment-node.d.ts
    - moment/moment.d.ts

以上でインストールは完了です。

TypeScriptを始めるときにはこの書籍が参考になります。対応しているバージョンが1.0と古いですが、基本的な事項は変わらないのでそのまま参考になります。

TypeScriptリファレンス Ver.1.0対応

TypeScriptリファレンス Ver.1.0対応