TypeScript 開発を効率化する *.d.ts ファイル活用術

2024-04-02

TypeScript における *.d.ts ファイルについて

型情報の提供

*.d.ts ファイルは、変数、関数、クラスなどの型情報を記述します。型情報を記述することで、コードの型安全性が高まり、開発時のエラーを減らすことができます。

外部ライブラリの利用

*.d.ts ファイルは、外部ライブラリの型情報を提供します。型情報が提供されているライブラリは、TypeScript コード内で型安全に利用することができます。

コードのドキュメント化

*.d.ts ファイルは、コードのドキュメント化にも役立ちます。型情報に加え、コメントを記述することで、コードの意味を明確にすることができます。

*.d.ts ファイルには、以下の種類があります。

宣言ファイルは、コードで使用される型情報を記述します。宣言ファイルは、declare キーワードを使用して記述します。

ambient モジュールは、宣言ファイルの一種です。ambient モジュールは、module キーワードを使用して記述します。

型定義ファイルは、外部ライブラリの型情報を提供します。型定義ファイルは、@types ディレクトリに配置されます。

手動で作成

テキストエディタを使用して、*.d.ts ファイルを手動で作成することができます。

ツールを使用して作成

*.d.ts ファイルの例

以下の例は、宣言ファイルの例です。

declare function add(x: number, y: number): number;

declare class Person {
  name: string;
  age: number;

  constructor(name: string, age: number);

  greet(): void;
}

このファイルは、add 関数と Person クラスの型情報を記述しています。

.d.ts ファイルは、TypeScript で重要な役割を果たします。.d.ts ファイルを活用することで、コードの型安全性と可読性を向上させることができます。

宣言ファイル (sample.d.ts)

declare function add(x: number, y: number): number;

declare class Person {
  name: string;
  age: number;

  constructor(name: string, age: number);

  greet(): void;
}

TypeScript コード (sample.ts)

// sample.d.ts を参照

import { add, Person } from "./sample";

const num1 = 10;
const num2 = 20;

const sum = add(num1, num2);
console.log(sum); // 30

const person = new Person("John Doe", 30);
person.greet(); // "Hello, my name is John Doe."