中級

文字列リテラルをenum型の引数に渡すとエラーになる理由

enumで定義した型は、見た目が近い文字列リテラルであっても別の型として扱われます。enumのメンバー名と同じ文字列を渡しても、enum型そのものの値でなければ代入・引数として受け付けられません。

エラーメッセージの読み方

main.ts(8,20): error TS2345: Argument of type '"Active"' is not assignable to parameter of type 'Status'.

main.ts

ファイル名

8

行番号

20

列番号 — この位置でtscが検査に失敗しました

TS2345

エラーコード — 検索するとTypeScriptの解説が見つかります

Argument of type '"Active"' is not assignable to parameter of type 'Status'.

内容 — 期待していたもの、または受け付けられなかったもの

このエラーが出る典型パターン

 1  enum Status {
 2    Active,
 3    Inactive,
 4  }
 5  function report(s: Status): string {
 6    return `status=${s}`;
 7  }
 8  console.log(report("Active"     ));
                             ^

 1  enum Color {
 2    Red,
 3    Blue,
 4  }
 5  function paint(c: Color): string {
 6    return `color=${c}`;
 7  }
 8  console.log(paint("Red"    ));
                          ^

 1  enum Level {
 2    Low,
 3    High,
 4  }
 5  function setLevel(l: Level): string {
 6    return `level=${l}`;
 7  }
 8  console.log(setLevel("Low"    ));
                             ^

 1  enum Mode {
 2    Auto,
 3    Manual,
 4  }
 5  function setMode(m: Mode): string {
 6    return `mode=${m}`;
 7  }
 8  console.log(setMode("Auto"   ));
                            ^

 1  enum Size {
 2    Small,
 3    Large,
 4  }
 5  function pick(s: Size): string {
 6    return `size=${s}`;
 7  }
 8  console.log(pick("Small"   ));
                          ^

よくある誤解

「enumのメンバー名と同じ文字列を渡せば通じるはず」という考えは誤りです。TypeScriptのenumは独自の名前的型（nominal-ishな型）を持ち、文字列リテラル型とは構造が似ていても別物として扱われます。

実務での勘所

TypeScriptのコミュニティでは、enumの代わりに文字列リテラルのunion型(type Status = "active" | "inactive";)を使うことを推奨する意見が広がっています。リテラルユニオンは普通の文字列リテラルとして扱えるため、このトピックのような「見た目は同じ文字列なのに型が違う」という混乱が起きません。enumはコンパイル後に実体を持つオブジェクトを生成するなど独自の癖も多く、新しいコードではenumより文字列リテラルのunion型を選ぶスタイルガイドが増えています。

演習をはじめる

関連するエラー

• is not assignable to type の原因と直し方変数への代入・関数の戻り値・プロパティへの代入など、宣言した型と違う型の値を渡そうとしたときにtscが検出するエラーです。
• keyof typeofで作ったキーの型は、存在しないキーを渡すとエラーになるkeyof typeof objは、実行時のオブジェクトobjが実際に持つキーだけを表すunion型（リテラル型の集合）になります。