できない.dev

unknown 型

別名: unknown / unknown type / TypeScript unknown

どんな値でも代入できるが、型を絞り込むまでプロパティ参照も呼び出しもできない TypeScript の型。
any の型安全な代わりとして、外から来る値や catch の例外を受け取るときに使う。

公開:

定義

unknown 型は、TypeScript 3.0 で入った「何が入っているか分からない値」を表す型である。
リリースノート(新しいタブで開く)は any の型安全な対になる型と説明している。
どんな値も unknown に代入できるが、unknown の値は型を絞り込むまで等値比較以外の操作ができない。

詳細

JSON.parse の結果や API のレスポンスのように中身を保証できない値は、unknown で受けてから typeof や instanceof、型ガード関数で絞り込むのが定石である。
TypeScript 4.4 からは useUnknownInCatchVariables が strict に含まれ、catch (e) の e が既定で unknown になった。

try {
  run();
} catch (e) {
  if (e instanceof Error) console.error(e.message);
}

よくある誤解

  • unknown は、any と同じように何でもできる型ではない。
    any は検査を外すが、unknown は絞り込むまで e.message のような参照をエラーにする。
  • as で変換しても安全にはならない。
    e as Error は検査を黙らせるだけで、実行時の値は変わらない。

関連

catch で出るエラーは 'e' is of type 'unknown'、型定義の無いライブラリで出る例は Property does not exist on type を参照する。