TypeScript StringLiteralで定義した型を用いてその中に含まれるかどうかを判断したい

Question

質問は2つあります

• 含まれるかをチェックする方法
• forEachなどで要素全部を辿る方法

以下、サンプルで示した例はエラーとなります(当たり前ではありますが)
イメージとしては以下のような感じです

type MyClubMember = 'taro' | 'jiro' | 'goro'

const name: string = 'taro'

console.log(name in MyClubMember) // error

上記例ではStringLiteralで定義していますが、constな値をカテゴリみたいな感じで管理するよりよい方法があれば教えて欲しいです。

よろしくお願いします。

Answer 1

こんにちは

enum を使うのはいかがでしょうか？

enum MyClubMember {
  TARO = 'taro',
  JIRO = 'jiro',
  GORO = 'goro'
};



Object.entries(MyClubMember).forEach(e => { 
  console.log(e);  // ["TARO", "taro"], ["JIRO", "jiro"], ["GORO", "goro"]
});


const members: MyClubMember[] = Object.values(MyClubMember);
console.log(members.includes('jiro'));    // true
console.log(members.includes('saburo'));  // false

• **動作確認用CodePen: ** https://codepen.io/jun68ykt/pen/wvBGobo?editors=0012

　

• 参考: TypeScript Deep Dive - 文字列列挙型(String Enums)

参考になれば幸いです。

Comments

[_Victorique__]

回答ありがとうございます！
includesの部分ですが、stringを引数に取れないという認識なのですがどうでしょうか？

[jun68ykt]

@_Victorique__さん
コメントありがとうございます。

> includesの部分ですが、stringを引数に取れないという認識なのですがどうでしょうか？
ご指摘、ありがとうございます。
はい。仰るとおりですね。

ですので

members.includes('saburo' as MyClubMember)

のようにチェックする文字列に as as MyClubMember を追加すればよいかと思います。
（CodePenに挙げたサンプルもそのように修正しました）

Answer 2

https://qiita.com/Yametaro/items/f8f9023c5e14c9a1e375
分かりやすい記事が出ていました

Answer 3

TypeScriptは分かりませんが、MyClubMember が持つ値がユニークなら、new Set はいかがですか。

const myClubMember = new Set(['taro' , 'jiro', 'goro']);

console.log(myClubMember.has('taro'));

for(let m of myClubMember) console.log(m);

ちなみに、new Set への格納値をString型に固定するのは、やや面倒です。
コンストラクタ処理、Set.prototype.set 処理で「型制限処理」を追加する必要があり、class を自作することになります。

Re: Victorique_ さん