TypeScriptのRecord型: Record<K, V>の使い方と例

Record<K, V> は、キーが K 型で値がすべて V 型のオブジェクトを表す組み込みのユーティリティ型です。string のキーなら辞書を表し、リテラルのキーのユニオン型なら、ちょうどそのキーを持たなければならないオブジェクトを表します。

// Any string key, number values
const stock: Record<string, number> = { apples: 12, pears: 0 };
stock.plums = 7;

// Exactly these three keys, each with a string value
type Lang = "en" | "de" | "fr";
const greeting: Record<Lang, string> = {
  en: "Hello",
  de: "Hallo",
  fr: "Bonjour",
};

console.log(stock);          // { apples: 12, pears: 0, plums: 7 }
console.log(greeting.de);    // Hallo

Record は型システムの中にしか存在しません。実行時にはどちらのオブジェクトも普通のJavaScriptのオブジェクトなので、オブジェクトリテラル、スプレッド、JSON.stringify、そのほかオブジェクトを受け取るあらゆるものと一緒に使えます。

構文と定義

Record<Keys, Value>

Keys はオブジェクトのキーになれるものでなければなりません。string、number、symbol、文字列や数値のリテラルのユニオン型、またはテンプレートリテラル型です。Value はどんな型でもかまいません。TypeScriptの標準ライブラリでの定義は、1行のマップ型です:

type Record<K extends keyof any, T> = {
  [P in K]: T;
};

keyof any は string | number | symbol で、ありうるすべてのキーの型の集合です。[P in K]: T は、K の各メンバーについて T 型のプロパティを1つ作ります。これで下の2つの動きが説明できます。string のような広い K はインデックスシグネチャ（任意のキー）を作り、ユニオン型の K はメンバーごとに1つの必須プロパティを作ります。

ユニオン型のキー: すべてのキーが必須

キーがリテラルのユニオン型のとき、Record はそのすべてを並べなければならず、それ以外は書けません。コンパイラーがチェックリストになります:

type Status = "idle" | "loading" | "success" | "error";

const label: Record<Status, string> = {
  idle: "Ready",
  loading: "Loading...",
  success: "Done",
  error: "Something went wrong",
};

const color: Record<Status, `#${string}`> = {
  idle: "#888888",
  loading: "#3b82f6",
  success: "#16a34a",
  error: "#dc2626",
};

function render(s: Status): string {
  return `${label[s]} (${color[s]})`;
}

console.log(render("success")); // Done (#16a34a)

Status に "cancelled" を追加すると、新しい状態にラベルと色を与えるまで、両方のオブジェクトがコンパイルできなくなります。キーを省いたり、ユニオン型にないキーを追加したりするとコンパイルエラーです:

// This does not compile: one key is missing and one is not allowed
type Status = "idle" | "loading" | "success" | "error";

const label: Record<Status, string> = {
  idle: "Ready",
  loading: "Loading...",
  success: "Done",
};

const icon: Record<Status, string> = {
  idle: "o", loading: "~", success: "v", error: "x", paused: "=",
};

index.ts(4,7): error TS2741: Property 'error' is missing in type '{ idle: string; loading: string; success: string; }' but required in type 'Record<Status, string>'.
index.ts(11,54): error TS2353: Object literal may only specify known properties, and 'paused' does not exist in type 'Record<Status, string>'.

キーの型として文字列 enum を使っても同じです。Record<Color, string> は enum のメンバーごとに1つのエントリーを要求します。

Record<string, T> と存在しないキー

string のキーではどんなキーも許され、TypeScriptは存在しないキーであってもすべての読み取りを T と型付けします。実行時には存在しないキーは undefined になります:

const prices: Record<string, number> = { tea: 2.5, coffee: 3.2 };

const juice = prices["juice"]; // typed number, but undefined at runtime
console.log(juice);            // undefined
console.log(juice * 2);        // NaN, and no compile error

// Check before you use it
if ("juice" in prices) {
  console.log("juice costs", prices.juice);
} else {
  console.log("no juice"); // no juice
}

// Or put undefined in the value type so the compiler makes you check
const safePrices: Record<string, number | undefined> = { tea: 2.5 };
const maybe = safePrices["juice"]; // number | undefined
console.log(maybe ?? 0);           // 0

これが Record でいちばんよくあるバグです。対処法は3つあります。読む前に in か Object.hasOwn でチェックする、値を V | undefined と宣言する、またはコンパイラーのオプション noUncheckedIndexedAccess を有効にして、プロジェクト内のすべてのインデックスシグネチャの読み取りに | undefined を加える、です。ユニオン型のキーを持つ Record にはこの問題はありません。すべてのキーが存在することが保証されているからです。

Partial<Record<K, V>>: 一部のキーだけ

キーのユニオン型を使いつつ、すべてを必須にしたくないなら、Record を Partial で囲みます。読み取りは V | undefined を返し、これが正直な型です:

type Lang = "en" | "de" | "fr" | "ja";

// Translations are optional per language, but only these languages are allowed
const title: Partial<Record<Lang, string>> = {
  en: "Settings",
  de: "Einstellungen",
};

function translate(lang: Lang): string {
  return title[lang] ?? title.en ?? "(missing)";
}

console.log(translate("de")); // Einstellungen
console.log(translate("ja")); // Settings

// Required "en", optional others
type Labels = Record<"en", string> & Partial<Record<Exclude<Lang, "en">, string>>;
const save: Labels = { en: "Save", fr: "Enregistrer" };
console.log(save); // { en: 'Save', fr: 'Enregistrer' }

jp のようにキーを打ち間違えるとやはりエラーになります。これが Record<string, string> に対する利点です。

Record をループする

Object.keys、Object.values、Object.entries はどれも使えます。落とし穴はキーの型です。Object.keys は string[] を、Object.entries は [string, V][] を返し、キーのユニオン型にはなりません:

type Plan = "free" | "pro" | "team";
const seats: Record<Plan, number> = { free: 1, pro: 1, team: 10 };

for (const [plan, n] of Object.entries(seats)) {
  console.log(plan, n); // plan is string, n is number
}
// free 1
// pro 1
// team 10

// When you need the union type, cast the keys
const plans = Object.keys(seats) as Plan[];
const total = plans.reduce((sum, p) => sum + seats[p], 0);
console.log(total); // 12

// for...in gives string keys too
for (const key in seats) {
  console.log(key.toUpperCase()); // FREE, PRO, TEAM on separate lines
}

TypeScriptがキーを意図的に string のままにしているのは、オブジェクトが実行時に型に書かれた以上のプロパティを持ちうるので、一般には Plan[] を約束するのは安全ではないからです。seats のようにリテラルから作ったオブジェクトなら、キャストしても安全です。

データから Record を作る

Record は、配列をグループ化したりインデックス化したりした結果としてよく使われます。Record 型の空のオブジェクトから始めて埋めていきます:

interface Book {
  id: string;
  title: string;
  genre: "fiction" | "science" | "history";
}

const books: Book[] = [
  { id: "b1", title: "Dune", genre: "fiction" },
  { id: "b2", title: "Cosmos", genre: "science" },
  { id: "b3", title: "Emma", genre: "fiction" },
];

// Index by id
const byId: Record<string, Book> = {};
for (const b of books) byId[b.id] = b;

// Group by genre (every genre present, even if empty)
const byGenre: Record<Book["genre"], string[]> = { fiction: [], science: [], history: [] };
for (const b of books) byGenre[b.genre].push(b.title);

console.log(byId.b2.title); // Cosmos
console.log(byGenre);       // { fiction: [ 'Dune', 'Emma' ], science: [ 'Cosmos' ], history: [] }

// Object.fromEntries gives { [k: string]: V }, which fits Record<string, V>
const titles: Record<string, string> = Object.fromEntries(books.map((b) => [b.id, b.title]));
console.log(titles); // { b1: 'Dune', b2: 'Cosmos', b3: 'Emma' }

Book["genre"] はインターフェースのユニオン型をキーの型として再利用しているので、Book にジャンルを追加すると byGenre が新しいエントリーを要求します。

Record<string, unknown> とインターフェース

Record<string, unknown> は「文字列のキーを持つ何かのオブジェクト」によく使われる型です。オブジェクトリテラルや type エイリアスで型付けした値は受け付けますが、インターフェースは拒否されます:

// This does not compile: interfaces have no implicit index signature
interface User {
  name: string;
}

function logFields(obj: Record<string, unknown>) {
  console.log(Object.keys(obj));
}

const user: User = { name: "Ada" };
logFields(user);

index.ts(11,11): error TS2345: Argument of type 'User' is not assignable to parameter of type 'Record<string, unknown>'.
  Index signature for type 'string' is missing in type 'User'.

インターフェースは宣言のマージで拡張できるので、TypeScriptはインターフェースがインデックスシグネチャに当てはまるとは考えません。型エイリアスはあとから開き直せないので、type User = { name: string } なら通ります。よくある直し方は、代わりに object を受け付ける（それでも Object.keys は呼べます）、関数をジェネリックにする（<T extends object>(obj: T)）、User を type で宣言する、のいずれかです（ほかの違いは interface と type の違い のページにあります）。

Record、インデックスシグネチャ、Map の比較

キーの集合がわかっているときは、ユニオン型のキーを持つ Record を選びましょう。すべてのキーが存在するかをチェックできる唯一の方法です。制限のない文字列のキーなら、Record<string, V> とインデックスシグネチャは交換可能で、読みやすさから Record を好むコードベースが多くあります。実行時にキーを追加・削除する場合、キーが文字列でない場合、余計な手間なしにサイズと挿入順が必要な場合は Map を使いましょう。