HOWTO · JavaScript
JavaScript の列挙子
今日の記事では、JavaScript の列挙子について学習します。
このページの内容
JavaScript には従来型の組み込み Enum 型はありません。通常の JavaScript では、位置が重要なら順序付き配列を使い、名前と数値を対応させるオブジェクトを作ることもできます。配列内の値を検索するには、indexOf(searchElement) で一致する値を探します。列挙型の構文を備えた TypeScript とは異なり、ここで紹介する JavaScript の方法は通常の配列やオブジェクトを使い、それぞれ異なる動作をします。
JavaScript における列挙型の役割
列挙型は、関連する値の決まった集合に意味のある名前を付ける仕組みです。JavaScript では、配列にもオブジェクトにも列挙型の規則が自動的に備わっているわけではなく、どちらも通常の変更可能な値です。値へのアクセス方法に応じて表現を選びましょう。順序を保ちたい場合や値の位置を調べたい場合は配列が便利です。すでに名前が分かっていて、対応する数値を取得したい場合はオブジェクトが便利です。
順序付きの値と検索が必要なら配列を使う
配列は値を書いた順序を保ちます。indexOf メソッドは最初に一致した位置を返し、一致する値がなければ -1 を返します。厳密等価で比較するため、型の異なる値は一致しません。同じ値が複数回含まれている場合は、最初の位置が返されます。
省略可能な fromIndex 引数で検索の開始位置を指定できます。0 以上の値を指定すると、その位置から検索します。負の値は配列の末尾から数えた位置を表します。計算された開始位置が最後の要素より後なら、一致する値は見つかりません。負の開始位置が配列の先頭より前になる場合は、先頭から検索します。詳しくは indexOf のリファレンスを参照してください。
次の例を実行してください。
このセクションのコードと表示されるラベルや出力は英語のままです。
const operatingSystems = ['Linux', 'macOS', 'Windows', 'Ubuntu'];
console.log(operatingSystems.indexOf('Linux'));
この例では、Linux などの OS 名はコード内の英語表記のままです。出力される数値は、最初に一致した値の 0 始まりの位置です。検索結果を有効な位置として扱う前に、-1 ではないことを確認してください。配列は変更可能でもあります。.push() で値を追加でき、.map() では各値を変換した新しい配列を作れます。これらの操作を使っても、配列が列挙型になるわけでも、値の集合が固定されるわけでもありません。
ループで列挙型のようなオブジェクトを作る
名前から数値を検索したい場合は、引数の一覧からプロパティ名を作り、それぞれの値に引数の位置を割り当てるオブジェクトをループで作成できます。この関数では arguments を使います。これは従来型の関数に渡された引数を含む、関数内で利用できるコレクションです。ここでの Enum はユーザー定義の関数名であり、JavaScript のキーワードや組み込み型ではありません。
このセクションのコードと表示されるラベルや出力は英語のままです。
function Enum() {
const values = {};
for (let i = 0; i < arguments.length; i++) {
values[arguments[i]] = i;
}
return values;
}
const operatingSystem = Enum('Linux', 'macOS', 'Windows', 'Ubuntu');
console.log(operatingSystem.Linux);
最初の引数であるため、Linux プロパティには 0 が割り当てられます。この例は通常のオブジェクトを返すので、new を使わずそのまま利用できます。引数名が重複すると、後から行われた代入によって先のプロパティ値が上書きされます。このオブジェクトは Object.prototype を継承するため、この単純な方法は管理された一覧の一般的な名前に使うのが適しています。信頼できない入力や任意の名前を扱う場合は、null プロトタイプのオブジェクトか Map を使ってください。この対応付けは一方向です。数値から名前を調べる逆引き機能はなく、プログラムの別の場所で代入された値も検証しません。
方式を選び、制約を理解する
順序が重要な場合や、値を indexOf で検索する場合は配列を使います。入力が既知の名前で、配列を検索するよりプロパティに直接アクセスする方が明確な場合は、名前と数値を対応させるオブジェクトを使います。どちらの方法でも、JavaScript は値の集合を固定したり、未知の値を禁止したり、要素を並べ替えた後も数値の位置が変わらないことを保証したりしません。
少数の定数を扱うなら、値をまとめて定義し、初期化後は変更しないという慣例を守りましょう。保存済みの数値、ネットワーク形式、複数のプログラム間で共有される値に依存するコードでは、数値を明示的に割り当て、インターフェースの一部として扱ってください。配列の位置から数値を導くと、並べ替えによって値の意味が気付かないうちに変わることがあります。TypeScript の列挙型ではコンパイル時の列挙型構文を使えますが、これは TypeScript の機能であり、JavaScript への出力にも独自の動作があります。プロジェクトで TypeScript の型システムを使っている場合に選び、JavaScript 標準の配列やオブジェクトにも同じ検査機能があると思い込まないでください。