TypeScript　keyof演算子の使い方のサンプル

2024年2月12日

環境
Windows　11 Pro 64bit
TypeScript 4.4.4

構文
type Person = {
プロパティ名1: string;
プロパティ名2: number;
};
type Keys = keyof Person;
型コンテキストで keyof を利用するとオブジェクトのプロパティ名を抽出して
文字列リテラルのユニオン型(String Literal Union) を取得できます。

使用例

type Person = {
  name: string;
  age: number;
};

type Keys = keyof Person; // "name" | "age"

let keys: Keys;
keys = 'name'; // OK
keys = 'age'; // OK
keys = 'xxx'; // Error: Type '"xxx"' is not assignable to type '"name" | "age"'.