Record в TypeScript: тип 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 занимает одну строку, это сопоставленный тип:

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

keyof any это string | number | symbol, множество всех возможных типов ключей. [P in K]: T создаёт по одному свойству типа T для каждого члена K. Этим объясняются оба поведения ниже: широкий K вроде string даёт сигнатуру индекса (любой ключ), а объединение в K даёт по одному обязательному свойству на каждый член.

Объединение ключей: каждый ключ обязателен

Когда ключи это объединение литералов, 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)

Добавьте "cancelled" в Status, и оба объекта перестанут компилироваться, пока вы не зададите новому статусу подпись и цвет. Пропущенный ключ или ключ, которого нет в объединении, это ошибка компиляции:

// 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.

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. Есть три способа с ней справиться: проверять через 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, когда ключи добавляются и удаляются во время выполнения, когда ключи не строки или когда без лишней работы нужны размер и порядок вставки.