Record em TypeScript: o tipo Record<K, V> explicado com exemplos

Record<K, V> é um utility type embutido para um objeto cujas chaves têm tipo K e cujos valores têm todos o tipo V. Com chaves string ele descreve um dicionário; com uma union de chaves literais ele descreve um objeto que precisa ter exatamente essas chaves.

// 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 existe só no sistema de tipos. Em tempo de execução, os dois objetos são objetos JavaScript comuns, então funcionam com object literals, spread, JSON.stringify e tudo o mais que recebe um objeto.

Sintaxe e definição

Record<Keys, Value>

Keys precisa ser algo que possa ser chave de objeto: string, number, symbol, uma union de literais string ou number, ou um template literal type. Value pode ser qualquer tipo. A definição inteira na biblioteca padrão do TypeScript tem uma linha, um mapped type:

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

keyof any é string | number | symbol, o conjunto de todos os tipos de chave possíveis. [P in K]: T cria uma propriedade do tipo T para cada membro de K. Isso explica os dois comportamentos abaixo: um K amplo como string produz uma index signature (qualquer chave), e um K em union produz uma propriedade obrigatória por membro.

Chaves em union: toda chave é obrigatória

Quando as chaves são uma union de literais, um Record precisa listar cada uma delas, e nenhuma outra. Isso transforma o compilador em uma checklist:

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)

Adicione "cancelled" a Status e os dois objetos param de compilar até você dar ao novo status um rótulo e uma cor. Deixar uma chave de fora, ou adicionar uma que não está na union, é erro de compilação:

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

O mesmo funciona com um string enum como tipo da chave: Record<Color, string> exige uma entrada por membro do enum.

Record<string, T> e a chave ausente

Com chaves string, qualquer chave é permitida, e o TypeScript tipa toda leitura como T, mesmo para uma chave que não existe. Em tempo de execução, uma chave ausente dá 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

Esse é o bug mais comum com Record. Há três jeitos de lidar com ele: verificar com in ou Object.hasOwn antes de ler, declarar o valor como V | undefined, ou ligar a opção do compilador noUncheckedIndexedAccess, que adiciona | undefined a toda leitura de index signature no projeto. Um Record com chaves em union não tem esse problema, porque toda chave tem existência garantida.

Partial<Record<K, V>>: só algumas chaves

Para usar uma union de chaves sem exigir todas, envolva o Record em Partial. As leituras então retornam V | undefined, o que é honesto:

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' }

Uma chave com erro de digitação, como jp, continua sendo erro, e essa é a vantagem em relação a Record<string, string>.

Percorrendo um Record

Object.keys, Object.values e Object.entries funcionam todos. O porém é o tipo da chave: Object.keys retorna string[] e Object.entries retorna [string, V][], nunca a sua union de chaves:

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
}

O TypeScript mantém as chaves como string de propósito: um objeto pode ter mais propriedades em tempo de execução do que o tipo dele lista, então prometer Plan[] seria inseguro em geral. Para um objeto que você criou a partir de um literal, como seats, o cast é seguro.

Montando um Record a partir de dados

Records são o resultado habitual de agrupar ou indexar um array. Comece com um objeto vazio do tipo Record e preencha:

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"] reaproveita a union da interface como tipo da chave, então adicionar um gênero a Book faz byGenre exigir uma nova entrada.

Record<string, unknown> e interfaces

Record<string, unknown> é um tipo comum para "algum objeto com chaves string". Ele aceita object literals e valores tipados com um type alias, mas uma interface é rejeitada:

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

Interfaces podem ser estendidas por declaration merging, então o TypeScript não presume que elas se encaixam em uma index signature; type aliases não podem ser reabertos, então um type User = { name: string } passaria. As correções habituais são aceitar object (você ainda pode chamar Object.keys nele), tornar a função genérica (<T extends object>(obj: T)) ou declarar User com type (a página interface vs type cobre as outras diferenças).

Record vs index signature vs Map

Escolha Record com chaves em union sempre que o conjunto de chaves for conhecido: é a única opção que verifica se todas as chaves estão presentes. Para chaves string abertas, Record<string, V> e uma index signature são intercambiáveis, e muitos projetos preferem Record pela legibilidade. Use um Map quando chaves são adicionadas e removidas em tempo de execução, quando as chaves não são strings, ou quando você precisa do tamanho e da ordem de inserção sem trabalho extra.