このガイドは、あなたに質の高いTypeScriptの宣言ファイルを書き方を指南するためのものです。

このガイドは、TypeScript言語に関する基本的な知識があることを前提としています。 まだ、それをお持ちでない場合は、TypeScriptのハンドブックを読んで、基本的な概念、特に型と名前空間について理解しておいてください。

セクション

ガイドは、以下のセクションに分かれています。

ライブラリ構造

ライブラリ構造のガイドは、共通ライブラリのフォーマットと、 各フォーマットの正しい宣言ファイルの記述方法を理解するのに役立ちます。 もし既に存在するファイルを編集しているのであれば、おそらくこのセクションを読む必要はありません。

新しく宣言ファイルを作成するのであれば、このセクションを読んで、 宣言ファイルのフォーマットにライブラリのフォーマットが、どのような影響を与えるかを正しく理解する必要があります。

べき・べからず集

多くの一般的な宣言ファイルに関する間違いは、簡単に避けることができます。 べき・べからず集のセクションは、 一般的なエラーを特定し、検出する方法とその修正方法について説明します。 よくある間違いを避けるために、このセクションをお読みください。

例

多くの場合、われわれを導く基礎となるライブラリの例しかない状態で、宣言ファイルを書くことに直面することでしょう。 例のセクションでは、多くの共通APIパターンと、それぞれの宣言を記述する方法が示されています。 このガイドは、まだTypeScriptのすべての言語構成に精通していないTypeScript初心者を対象としています。

Deep Dive

Deep Diveセクションでは、宣言ファイルの仕組みの基礎となるメカニズムに興味を持つ経験豊富な作成者のために、 宣言文の多くの高度な概念について説明し、これらの概念を活用してよりクリーンでより直感的な宣言ファイルを作成する方法を示します。

d.tsのテンプレート集

d.tsのテンプレート集では、新しいファイルを作成するにあたって役立つ幾つかの宣言ファイルが提供されています。 使用するテンプレートファイルを理解するには、ライブラリ構造のドキュメントを参照してください。

npmへの公開

宣言ファイル(d.ts)の公開セクションでは、npmパッケージへ宣言ファイルを公開する方法を説明し、 依存パッケージを管理する方法をご覧いただきます。

宣言ファイルの検索とインストール

JavaScriptのライブラリを使用するユーザーのために、宣言ファイル(d.ts)の使用セクションでは、 対応する宣言ファイルを検索してインストールする簡単な手順を紹介します。

 Back to top