js - Javascript で enum を定義する方法

Question

質問内容

Javascript で、配列の添字として使用できるように、整数型の列挙子を定義したいのですがどのように書けばいいのでしょうか？
Typescript では enum 構文があるようですが、Javascript には enum 構文がないです。

以下の C++ の列挙子のようにキャスト不要で整数型として認識される列挙子を定義したいです。
よろしくおねがいします。

探しているもの

• 定数 (あとから変更することはない)
• 整数の値を表し、配列の添字として使用できる
• -1 始まりの連続した整数 (-1, 0, 1, 2, ...)
• ある名前空間以下に定数を定義したい (C++ でいうと、ある名前空間の中に定義して Zero ではなく、Number::Zero として定数を参照する)

#include <iostream>
#include <vector>

struct Number
{
    enum Type
    {
        Null = -1,  // -1 を表す定数
        Zero,       //  0 を表す定数
        One,        //  1 を表す定数
        Two,        //  2 を表す定数
    };
};

int main()
{
    std::vector<std::string> array = {"a", "b", "c"};

    // 整数型として認識される列挙子
    std::cout << array[Number::Two] << std::endl; // c
    std::cout << std::boolalpha << (Number::Two == 2) << std::endl; // true
}

試したこと

調べたところ、Symbol を使ったサンプルが出てきたのですが、整数型とは認識されていないためか添字としては利用できないようでした。

const Number = Object.freeze({
  Zero: Symbol(0),
  One: Symbol(1),
  Two: Symbol(2)
});

let array = ["a", "b", "c"];

console.log(array[Number.Two]);  // undefined

1つ1つ変数として定義していく方法も考えましたが、グローバル名前空間に定義されてしまうことと、50個ぐらい定数があり煩雑となるため、より簡潔な方法がありましたら教えて下さい。

const Zero = 0;
const One = 1;
const Two = 2;

環境

• ES 2019

Comments

[miyabi_pudding]

JavaScriptは動的型付けのため、返す値の型を縛るのは非常に難しいと思うのですが（故にジェネリクスも使えません）、
Swiftの列挙型の、rawValueメソッドのように、
列挙型のメソッドを用いて、設定した値を取り出す方法を使えば擬似的に実現できると思うのですが、
それだといかがでしょうか？
（Object.definePropertyを上手く使えば、型もある程度縛れるかもしれない）

[tiitoi]

コメントありがとうございます。
配列を添字で参照する際に数値を直接書く代わりに、Number.One、Number.Two、... のような感じでコードを読みやすいように変数(定数)名で代用したいというのが目的なので、定義される変数の型は保証できなくてよいです。

> 列挙型のメソッドを用いて、設定した値を取り出す方法を使えば擬似的に実現できると思うのですが、それだといかがでしょうか？

すみません。列挙型のメソッドとはどれのことでしょうか？

[miyabi_pudding]

Swiftの列挙型は、定義時に、
rawValueというメソッドを持ち得まして、
列挙型定義時に、添え字に対して与えた値を取り出すことができます。
それを、JavaScriptで擬似的に実装することはできると思います。

手前味噌ではありますが、以前、JSで擬似列挙型に挑戦したことがあるので、回答させていただきます。

Answer 1

こういうことでしょうか。

const number = Object.freeze({
  Zero: 0,
  One: 1,
  Two: 2
});

Javascript で、配列の添字として使用できるように、整数型の列挙子を定義したいのですがどのように書けばいいのでしょうか？

ECMAScript2019ではオブジェクトのプロパティ名に指定出来るのはString型/Symbol型だけです。
Mapをつかえば、Number型を扱う事は出来ます。

const map = new Map([[-1,'Null'], [0,'Zero'], [1,'One'], [2,'Two']]);

Re: tiitoi さん

Comments

[tiitoi]

ご回答ありがとうございます。想定通りの挙動になりました。
Symbol() にせずにそのまま値に数値を設定すればよかったのですね。

[think49]

> Symbol() にせずにそのまま値に数値を設定すればよかったのですね。

Symbol() は Symbol 型の値を返しますが、
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Symbol
数値リテラル(0,1,2,3...)は Number 型です。

> 整数型の列挙子を定義したいのですが

ECMAScript2019に整数型はなく、整数値と浮動小数値をひとまとめにした Number 型がIEEE 754の範疇で定義されています。
https://jsprimer.net/basic/data-type/

---
まずはこれらの型の違いを調査することから始める事をお勧めします。

仕様書を読めるのでしたら、ES2020を読むのが良いです。
http://www.ecma-international.org/ecma-262/11.0/#sec-ecmascript-data-types-and-values
http://www.ecma-international.org/ecma-262/11.0/#sec-typeof-operator

特に Object 型を別の名前(Function型,Array型,Element型...etc)と誤認する人が多いので、注意が必要です。

Answer 2

Enumクラスの定義です。
（JavaScriptの抽象化は、クラスか大元のプロトタイプしか手段がありません）

const EnumCaseStruct = (() => {
  const key = Symbol();
 
  return class EnumCaseStruct {
    constructor(val) {
      this[key] = val;
    }
    // Swiftを参考に、rawValueで、値を取得できるようにしている
    get rawValue() {
      return this[key];
    }
  };
})();
 
class Enum {
  constructor(...cases) {
    if (!cases.every(v => {
      switch (typeof v) {
        case 'object':
          // オブジェクトの場合、各キー値にて、上のクラスのインスタンスとして定義
          Object.keys(v).forEach(ve => {
            Object.defineProperty(this, ve, {value: new EnumCaseStruct(v[ve])});
          });
          return true;
        case 'string':
          // 文字列型なら、そのまま初期化する
          Object.defineProperty(this, v, {value: new EnumCaseStruct(v)});
          return true;
          defalult:
            // オブジェクトか、文字列型以外は受け付けないようにする
            return false;
      }
    })) {
      // オブジェクトか文字列以外は、エラーをスローする
      throw new Error('Type error!');
    }
  }
}

使用の仕方です。

const fruits = new Enum(
  {apple: 25},
  {melon: 125}
);
 
const apple01 = fruits.apple;
const apple02 = fruits.apple;
console.log(apple01 == apple02); // true
 
// 可変長引数のため、下記のようにも定義可能
const fruits02 = new Enum(
  {
    apple: 25,
    melon: 125
  },
  'pine'
);
// 各列挙型は各値が一意となるため、比較時は偽となる。
console.log(fruits.apple == fruits02.apple); // false
// Swiftを参考に、rawValueにて、設定した値を返す
console.log(fruits.apple.rawValue); // 25
// 文字列をそのまま入れた場合は、rawValueはその文字列を返す
console.log(fruits.pine.rawValue); // pine

あくまで、擬似的なため、
要件に満たないかもしれませんが、
だいぶ列挙型の使用感に近づけれはしたかと思います。

Comments

[tiitoi]

回答いただきありがとうございます。試してみました。

const fruits = new Enum(
{apple: 0},
{melon: 1}
);
array = [1, 2, 3]
console.log(fruits.apple == 0); // false
console.log(array[fruits.apple]); // undefined

配列の添字アクセスに使いたいのですが、fruits.apple が0を表すようにはできないでしょうか？

[miyabi_pudding]

すみません、その場合は、
fruits.apple.rawValue
にて、0を取り出せるようにはなっています。
ただ、列挙型を一意にするために、
直接の添え字には、Symbol値を使っているため、直接、
fruits.appleから値を取り出すのは、
できないような設計になってます。

ただ、値が定数になれば良いのであれば、
Object.definePropertyを使えば可能になると思います。
上記メソッドは、
第一引数に対象のオブジェクト、
第二引数に、プロパティ名や値をいれることによって、
そのオブジェクトの定数プロパティを定義できるというものです。
MDNにて、詳しく書かれています。

[tiitoi]

なるほど。理解しました。確かに Python の enum も値を value で取り出すといった似たような仕様になっていますね。
Object.defineProperty() についても調べてみます。Javascript は始めたばかりで知らないことが多いのですが、勉強させていただきます。
ご回答ありがとうございました。

[miyabi_pudding]

列挙型に囚われてしまい、少々大仰な回答になってしまったようです。すみません。
私の構文は、Pythonや、Swiftの列挙型の仕様に寄せた実装になっていると思います。

JavaScriptは、何かと自由度が高いですが、その分他の言語ではできるようなことが、逆にできなかったりするのが厄介だと思います　汗