TypeScript 列挙型(Enum)
列挙型(Enum)は TypeScript の中でも非常に便利な機能で、一連の名前付き定数を定義できます。列挙型を使うと、コードがより読みやすく、保守しやすくなり、意味のある名前で「マジックナンバー」を置き換えられます。
数値列挙型
デフォルトでは、列挙型は 0 から番号が付けられます。
例
enum Direction {
Up, // 0
Down, // 1
Left, // 2
Right // 3
}
var dir: Direction = Direction.Up;
console.log("方向: " + dir);
console.log("方向名: " + Direction[0]);
Up, // 0
Down, // 1
Left, // 2
Right // 3
}
var dir: Direction = Direction.Up;
console.log("方向: " + dir);
console.log("方向名: " + Direction[0]);
実行結果:
方向: 0 方向名称: Up
手動での値の割り当て
列挙型のメンバーに手動で値を指定できます。
例
enum Status {
Success = 1,
Error = 2,
Pending = 3
}
console.log("状態: " + Status.Success);
console.log("状態名: " + Status[1]);
Success = 1,
Error = 2,
Pending = 3
}
console.log("状態: " + Status.Success);
console.log("状態名: " + Status[1]);
実行結果:运
ステータス: 1 状态名称: Success
文字列列挙型
文字列列挙型の各メンバーは、文字列リテラル値を持つ必要があります。
例
enum Message {
Success = "SUCCESS",
Error = "ERROR",
Warning = "WARNING"
}
console.log("メッセージ: " + Message.Success);
Success = "SUCCESS",
Error = "ERROR",
Warning = "WARNING"
}
console.log("メッセージ: " + Message.Success);
実行結果:
メッセージ: SUCCESS
定数列挙型
使用const修飾された列挙型はコンパイル時にインライン展開され、より最適化されたコードが生成されます。
例
const enum Color {
Red = "RED",
Green = "GREEN",
Blue = "BLUE"
}
var favoriteColor: Color = Color.Red;
console.log("好きな色: " + favoriteColor);
Red = "RED",
Green = "GREEN",
Blue = "BLUE"
}
var favoriteColor: Color = Color.Red;
console.log("好きな色: " + favoriteColor);
異種列挙型
列挙型は数値と文字列の値を混在させることができますが、推奨されません。
例
enum BooleanLikeHeterogeneousEnum {
No = 0,
Yes = "YES"
}
console.log("値: " + BooleanLikeHeterogeneousEnum.No);
console.log("文字列値: " + BooleanLikeHeterogeneousEnum.Yes);
No = 0,
Yes = "YES"
}
console.log("値: " + BooleanLikeHeterogeneousEnum.No);
console.log("文字列値: " + BooleanLikeHeterogeneousEnum.Yes);
列挙型メンバーの型
列挙型のメンバーがすべてリテラル値の場合、そのメンバー型を型として使用できます。
例
enum ShapeKind {
Circle = "circle",
Square = "square"
}
interface Circle {
kind: ShapeKind.Circle;
radius: number;
}
interface Square {
kind: ShapeKind.Square;
sideLength: number;
}
var c: Circle = {
kind: ShapeKind.Circle,
radius: 10
};
console.log("円形: " + JSON.stringify(c));
Circle = "circle",
Square = "square"
}
interface Circle {
kind: ShapeKind.Circle;
radius: number;
}
interface Square {
kind: ShapeKind.Square;
sideLength: number;
}
var c: Circle = {
kind: ShapeKind.Circle,
radius: 10
};
console.log("円形: " + JSON.stringify(c));
実行時の列挙型
通常の列挙型は実行時に実オブジェクトとして保持されます。
例
enum FileAccess {
Read = 1 << 1,
Write = 1 << 2,
ReadWrite = Read | Write
}
console.log("ファイルアクセス: " + FileAccess.ReadWrite);
Read = 1 << 1,
Write = 1 << 2,
ReadWrite = Read | Write
}
console.log("ファイルアクセス: " + FileAccess.ReadWrite);
実行結果:
文件访问: 6
まとめ
- 数値列挙型:デフォルトでは 0 から始まり、手動で代入可能
- 文字列列挙型:各メンバーは文字列リテラルである必要がある
- 定数列挙型:const を使用し、コンパイル時にインライン展開される
- 異種列挙型:数値と文字列を混在させることは推奨されない
- メンバー型:リテラル列挙型メンバーは型として使用できる