Typescriptsで変数をUnion型に変換できるかどうかのチェック方法について

Question

やりたいことは以下です

type Hoge = 'foo' | 'bar' | 'baz'
const foo = 'foo'

// 変数fooがHoge型に変換可能かをチェックしたい

ユーザー定義型ガード？を作成することになるのかなと思いその文脈で調べていたのですが、
上記のケースの対応を書いている記事が見つからなかったため質問させていただきました。

ご教示宜しくお願い致します。

Comments

[maisumakun]

fooの型はstring、ということで間違いないですか？

[tanana_m]

間違い無いです！

Answer 1

上記のケースの対応を書いている記事が見つからなかったため質問させていただきました。

ただ単にチェックするコードを書くしかありません（仮に間違えて書いても、TypeScriptコンパイラがチェックすることもありませんのでご注意ください）。

function isHoge(value: string): value is Hoge {
  return value === 'foo' || value === 'bar' || value === 'baz';
}

（配列の定数を使って型定義とチェックの両方を効率化、という方法も考えられます）

const hogeKeys = ['foo', 'bar', 'baz'] as const;

// 配列の型から要素の型を取得する
type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];

type Hoge = ArrayElement<typeof hogeKeys>

function isHoge(value: unknown): value is Hoge {
  return (hogeKeys as readonly unknown[]).indexOf(value) !== -1;
}

Comments

[tanana_m]

ありがとうございます。
実際にはHogeの定義が膨大で（システムのメッセージコードを定義している）、
チェックのために再度　value === 'foo' | value === 'bar'　などと書くのが現実的では無い量なのですが、
これに関しての解決策は何かないでしょうか。
（後者のやり方だと配列を再度定義しなくてはならなく…）

[maisumakun]

> 後者のやり方だと配列を再度定義しなくてはならなく…

後者のやり方で、配列から型を導出する、とやるよりありません。

TypeScriptの型情報はコンパイルで消えてなくなりますので、実行時のチェックに使うには「値」として出現させる必要があります。

[tanana_m]

理解しました。ありがとうございました。