TypeScript で Enum を拡張する
TypeScript では、Enum を直接拡張することはできません。しかし、いくつかの手法を用いて、ある Enum をベースに新たな Enum を作成することができます。これにより、コードの再利用性と保守性を向上させることができます。
手法 1: Enum の再定義と拡張
-
元の Enum を定義
enum Color { Red, Green, Blue } -
新しい Enum を定義し、元の Enum の値をコピー
enum ExtendedColor { Red = Color.Red, Green = Color.Green, Blue = Color.Blue, Yellow, Purple }
この方法により、新しい Enum ExtendedColor には、元の Color の値に加えて、新たな値 Yellow と Purple が追加されています。
手法 2: Union Type と Literal Type の活用
-
元の Enum の値を Literal Type として定義
type Color = 'Red' | 'Green' | 'Blue'; -
新しい Enum を Union Type として定義
type ExtendedColor = Color | 'Yellow' | 'Purple';
この方法では、元の Enum の値を Union Type に組み込むことで、拡張を実現しています。ただし、この方法では、元の Enum の値を直接継承するのではなく、新たな値を追加する形になります。
どちらの方法を選ぶべきか
- 手法 2
より柔軟な拡張が必要な場合や、文字列の値を直接使用したい場合に適しています。 - 手法 1
元の Enum の値を直接継承したい場合や、数値の連番を維持したい場合に適しています。
注意
- 上記の手法は、あくまでも Enum の拡張のシミュレーションであり、厳密な継承ではありません。
- TypeScript の Enum はコンパイル時に数値に変換されるため、直接の継承はできません。
TypeScript-Typings
TypeScript-Typings は、TypeScript の型定義ファイルの集合です。これにより、サードパーティライブラリや JavaScript ライブラリを TypeScript でよりスムーズに利用することができます。Enum の拡張に関しても、サードパーティライブラリが提供する Enum を拡張する場合には、そのライブラリの型定義ファイルを参照し、適切な方法で拡張する必要があります。
// 元の Enum
enum Color {
Red,
Green,
Blue
}
// 拡張された Enum
enum ExtendedColor {
Red = Color.Red,
Green = Color.Green,
Blue = Color.Blue,
Yellow,
Purple
}
// 元の Enum の値を Literal Type として定義
type Color = 'Red' | 'Green' | 'Blue';
// 拡張された Enum を Union Type として定義
type ExtendedColor = Color | 'Yellow' | 'Purple';
この方法では、元の Enum の値を Union Type に組み込むことで、拡張を実現しています。
使用例
function getColorName(color: ExtendedColor): string {
switch (color) {
case ExtendedColor.Red:
return '赤';
case ExtendedColor.Green:
return '緑';
case ExtendedColor.Blue:
return '青';
case ExtendedColor.Yellow:
return '黄';
case ExtendedColor.Purple:
return '紫';
default:
return '不明';
}
}
console.log(getColorName(ExtendedColor.Red)); // 出力: 赤
console.log(getColorName(ExtendedColor.Yellow)); // 出力: 黄
この手法では、インターフェースを使用して Enum の形状を定義し、マッピング型を使って新しい Enum を作成します。
interface Color {
Red: string;
Green: string;
Blue: string;
}
type ExtendedColor = Color & {
Yellow: string;
Purple: string;
};
const extendedColor: ExtendedColor = {
Red: '赤',
Green: '緑',
Blue: '青',
Yellow: '黄',
Purple: '紫'
};
文字列型によるアプローチ
この手法では、Enum の値を文字列として定義し、新しい Enum を作成します。
enum Color {
Red = 'Red',
Green = 'Green',
Blue = 'Blue'
}
enum ExtendedColor {
Red = Color.Red,
Green = Color.Green,
Blue = Color.Blue,
Yellow = 'Yellow',
Purple = 'Purple'
}
継承とミックスインによるアプローチ
この手法は、TypeScript のクラス継承とミックスインの概念を利用して、Enum のような振る舞いを模倣します。
class BaseColor {
static Red = 'Red';
static Green = 'Green';
static Blue = 'Blue';
}
class ExtendedColor extends BaseColor {
static Yellow = 'Yellow';
static Purple = 'Purple';
}
選択する手法
- 継承とミックスイン
クラスベースのオブジェクト指向アプローチを好む場合に適していますが、やや複雑な実装が必要になります。 - 文字列型
シンプルな拡張方法ですが、型チェックの厳密さが多少低下します。 - インターフェースとマッピング型
より柔軟な拡張が可能で、型安全性を確保できます。
typescript typescript-typings
