TypeScript で string から enum に変換したいときの便利な書き方、または namespace を使わない方法について

Question

TypeScript で string から enum に変換したいときに、
毎回、as any とか as enum名 とか書くのが面倒で、
enum 毎に、下記のような関数を用意して使っています。

enum Color {
  Red,
  Green,
  Blue,
}
export default Color;

namespace Color {
  export function fromString(str: string): Color {
    return (Color as any)[str] as Color;
  }
}

const b: Color = Color.fromString('Blue');
console.log(b);

ただ、この書き方だと、

• enum 毎に毎回関数を作らないといけないのが面倒
• tslint で以下のように怒られるので非推奨な書き方なのだろうと思われる

'namespace' and 'module' are disallowed (no-namespace)

という問題があり、
こういう場合に便利な書き方は無いでしょうか？

Answer 1

こんにちは

一案としまして、以下

• TypeScript Deep Dive 日本語版: 文字列ベースの列挙型

に記載されている下記のサンプルと同じような方法で、ご質問に挙げられている type Color を作成するのはいかがでしょうか？

/** Utility function to create a K:V from a list of strings */
function strEnum<T extends string>(o: Array<T>): {[K in T]: K} {
  return o.reduce((res, key) => {
    res[key] = key;
    return res;
  }, Object.create(null));
}

/**
  * Sample create a string enum
  */

/** Create a K:V */
const Direction = strEnum([
  'North',
  'South',
  'East',
  'West'
])
/** Create a Type */
type Direction = keyof typeof Direction;

/** 
  * Sample using a string enum
  */
let sample: Direction;

sample = Direction.North; // Okay
sample = 'North'; // Okay
sample = 'AnythingElse'; // ERROR!

参考になれば幸いです。

Comments

[tanishi_a]

おお！ これは求めているものっぽいです。
試しに書いてみると、バッチリ補完も効きますね。フシギ。

[jun68ykt]

コメントありがとうございます。

> バッチリ補完も効きますね。フシギ。

はい。効いてくれます。その
> フシギ。
を解消して納得するには、strEnum でやっていることや、 keyof と　typeof とを連続して、keyof typeof Direction　と書くところをきっちり読み解く必要がありそうです。(私はまだその辺りの詳細は読み切れていませんが･･･）

ちなみに、tanishi_aさんと同様な経緯で、TypeScript Deep Dive　の上記のサンプルをみつけた方のブログ記事もありました。

TypeScriptのString Enumsを少し便利にするTips (mitsuruogさん)
https://blog.mitsuruog.info/2019/04/typescript-string-emun-tips

[tanishi_a]

補足もありがとうございます。

これ使うと文字列にするために `Color[Color.Red]` みたいにする必要もなくなりますね。
使わない手が無いような気がしてきました。

[jun68ykt]

そうですね。サンプルのコードで、
sample = 'AnythingElse';
と代入しようとするとエラーになってくれる所も、なかなか優れモノですね。