モジュール拡張の概要

モジュール拡張を使うと、既存のモジュールを拡張または変更できるため、TypeScriptのライブラリやモジュールにカスタムプロパティやメソッドを追加できます。

追加の機能やカスタム型が必要なサードパーティライブラリを扱う場合に、特に役立ちます。

モジュール拡張とは

モジュール拡張では、既存のモジュールを再度開き、declare module構文を使って型や機能を追加または変更します。

モジュール拡張の基本例

expressモジュールを拡張して、Requestオブジェクトにカスタムプロパティを追加する例を見てみましょう。

import 'express';

declare module 'express' {
  interface Request {
    user?: { id: string; role: string };
  }
}

拡張したモジュールの使用

モジュールを拡張した後は、アプリケーションで拡張された機能を使用できます。

import express from 'express';

const app = express();

app.use((req, res, next) => {
  req.user = { id: '123', role: 'admin' };
  next();
});

app.get('/', (req, res) => {
  res.send(`User ID: ${req.user?.id}`);
});

サードパーティモジュールへのカスタム型の追加

モジュール拡張は、ユースケースを完全にはカバーしていないサードパーティライブラリにカスタム型を追加するためによく使われます。

モジュール拡張時の注意点

モジュールを拡張するときは、次の点に注意してください。

• 既存の型を意図せず上書きしないようにしてください。
• コードを保守しやすくするため、変更内容をドキュメント化してください。
• グローバルな型が乱雑になるのを避けるため、必要な場合にのみモジュール拡張を使用してください。

実際の使用例

モジュール拡張は、次のような場面でよく使われます。

• サードパーティライブラリを拡張して、アプリケーション固有のプロパティを追加する。
• Express.jsなどのフレームワークにカスタムミドルウェアプロパティを追加する。
• 特定のプロジェクト要件に合わせてモジュールを適応させる。

練習課題

expressモジュールのRequestオブジェクトを拡張して、カスタムのisAuthenticatedメソッドを追加してください。このメソッドをサンプルのミドルウェア関数で使用しましょう。

おめでとうございます！

TypeScriptでモジュール拡張を使い、既存のモジュールを拡張または変更する方法を学びました。このスキルを練習して、サードパーティライブラリをカスタマイズし、アプリケーションを強化しましょう。