TypeScript で npm モジュールを使う
Node.js で TypeScript を使用する場合、npm モジュールをインポートして利用することができます。以下にその手順を説明します。
npm モジュールのインストール
npm を使って必要なモジュールをインストールします。例えば、lodash モジュールをインストールする場合、ターミナルで以下のコマンドを実行します。
npm install lodash --save-dev
--save-dev オプションは、開発環境でのみ必要なモジュールとしてインストールします。
TypeScript プロジェクトの設定
TypeScript プロジェクトを適切に設定していることを確認してください。tsconfig.json ファイルでコンパイラオプションを指定します。
{
"compilerOptions": {
"target": "es6",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true
}
}
モジュールのインポートと使用
TypeScript ファイル内で、インポート文を使ってモジュールをインポートします。
import * as _ from 'lodash';
const numbers = [1, 2, 3, 4, 5];
const sum = _.sum(numbers);
console.log(sum); // Output: 15
重要なポイント
- モジュール解決
TypeScript はモジュール解決の仕組みを持っています。tsconfig.jsonファイルのbaseUrlとpathsオプションを使って、モジュールの解決方法をカスタマイズすることができます。 - 型定義ファイル
多くの npm モジュールは型定義ファイルを提供しています。これにより、TypeScript コンパイラは型チェックを行い、より安全なコードを書くことができます。型定義ファイルは通常@typesパッケージとして提供されており、npm でインストールすることができます。npm install --save-dev @types/lodash
npm install lodash --save-dev
TypeScript ファイルでのインポートと使用
import * as _ from 'lodash';
const numbers = [1, 2, 3, 4, 5];
// lodash の sum 関数を使って配列の要素の合計を計算
const sum = _.sum(numbers);
console.log(sum); // Output: 15
型定義ファイルの利用
多くの npm モジュールは型定義ファイルを提供しています。これにより、TypeScript コンパイラはより厳密な型チェックを行い、開発効率とコードの信頼性を向上させます。
// 型定義ファイルのインストール
npm install --save-dev @types/lodash
// TypeScript ファイルでの使用
import * as _ from 'lodash';
const numbers: number[] = [1, 2, 3, 4, 5];
// 型安全なコード
const sum: number = _.sum(numbers);
複雑なモジュールのインポート
より複雑なモジュールの場合、特定のエクスポートをインポートすることもできます。
import { sumBy } from 'lodash';
const objects = [{ n: 1 }, { n: 2 }, { n: 3 }];
const total = sumBy(objects, 'n');
console.log(total); // Output: 6
TypeScript プロジェクト内で作成したカスタムモジュールもインポートできます。
// utils.ts
export function greet(name: string) {
console.log(`Hello, ${name}!`);
}
// main.ts
import { greet } from './utils';
greet('Alice');
- モジュールシステム
Node.js では CommonJS と ECMAScript Modules (ESM) の2つのモジュールシステムが使用できます。TypeScript はこれら両方をサポートしています。 - 型チェック
型定義ファイルを利用することで、TypeScript コンパイラはより厳密な型チェックを行い、潜在的なエラーを早期に発見できます。
tsconfig.json ファイルのコンパイラオプションを適切に設定することで、モジュールのインポートと解決を制御できます。
{
"compilerOptions": {
"target": "es6",
"module": "commonjs", // または "esnext"
"esModuleInterop": true, // ESM と CommonJS の相互運用を可能にする
"forceConsistentCasingInFileNames": true,
"baseUrl": "./src", // ベースディレクトリを設定
"paths": {
"@utils/*": ["utils/*"] // カスタムモジュールのエイリアスを設定
}
}
}
Module Resolution Strategies
TypeScript は Node.js のモジュール解決戦略をサポートしています。
- Classic resolution
TypeScript プロジェクトのルートディレクトリから相対パスでモジュールを検索します。 - Node.js-style resolution
node_modulesディレクトリからモジュールを検索します。
Dynamic Imports
動的にモジュールをインポートするには、import() 関数を使用します。
const modulePromise = import('./myModule');
modulePromise.then(module => {
module.default();
});
TypeScript Compiler Options
- lib
標準ライブラリのインクルードを指定します。 - types
グローバル型定義ファイルのパスを指定します。 - moduleResolution
モジュール解決戦略を指定します。
Best Practices
- ビルドツール
Webpack や Rollup などのビルドツールを使用して、モジュールをバンドルし最適化しましょう。 - 依存関係管理
npm を使って依存関係を管理しましょう。 - モジュールの分割
プロジェクトを小さなモジュールに分割することで、保守性を向上させます。 - 型定義ファイルの利用
型安全なコードを書くために、型定義ファイルを使用しましょう。
node.js typescript npm
