Record w TypeScript: typ Record<K, V> na przykładach

Record<K, V> to wbudowany typ narzędziowy dla obiektu, którego klucze mają typ K, a wszystkie wartości typ V. Z kluczami string opisuje słownik; z unią kluczy literałowych opisuje obiekt, który musi mieć dokładnie te klucze.

// 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 istnieje tylko w systemie typów. W czasie działania oba obiekty to zwykłe obiekty JavaScript, więc działają z literałami obiektów, rozkładaniem, JSON.stringify i wszystkim innym, co przyjmuje obiekt.

Składnia i definicja

Record<Keys, Value>

Keys musi być czymś, co może być kluczem obiektu: string, number, symbol, unią literałów tekstowych lub liczbowych albo template literal type. Value może być dowolnym typem. Cała definicja w bibliotece standardowej TypeScriptu to jedna linia, typ mapowany:

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

keyof any to string | number | symbol, zbiór wszystkich możliwych typów kluczy. [P in K]: T tworzy jedną właściwość typu T dla każdego elementu K. To wyjaśnia oba zachowania opisane niżej: szeroki K, taki jak string, daje sygnaturę indeksu (dowolny klucz), a K będący unią daje jedną wymaganą właściwość na każdy element.

Klucze z unii: każdy klucz jest wymagany

Gdy klucze są unią literałów, Record musi zawierać każdy z nich i żadnego innego. To zamienia kompilator w listę kontrolną:

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)

Dodaj "cancelled" do Status, a oba obiekty przestaną się kompilować, dopóki nie dasz nowemu statusowi etykiety i koloru. Pominięcie klucza albo dodanie takiego, którego nie ma w unii, to błąd kompilacji:

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

To samo działa z enumem tekstowym jako typem klucza: Record<Color, string> wymaga jednego wpisu na każdy element enuma.

Record<string, T> i brakujący klucz

Przy kluczach string dozwolony jest dowolny klucz, a TypeScript typuje każdy odczyt jako T, nawet dla klucza, którego nie ma. W czasie działania brakujący klucz daje 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

To najczęstszy błąd z Record. Są trzy sposoby, żeby sobie z nim poradzić: sprawdź przez in lub Object.hasOwn przed odczytem, zadeklaruj wartość jako V | undefined albo włącz opcję kompilatora noUncheckedIndexedAccess, która dodaje | undefined do każdego odczytu przez sygnaturę indeksu w projekcie. Record z kluczami z unii nie ma tego problemu, bo każdy klucz na pewno istnieje.

Partial<Record<K, V>>: tylko niektóre klucze

Aby użyć unii kluczy, ale nie wymagać wszystkich, opakuj Record w Partial. Odczyty zwracają wtedy V | undefined, co jest uczciwe:

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

Błędnie wpisany klucz, taki jak jp, nadal jest błędem, i to przewaga nad Record<string, string>.

Iterowanie po Record

Object.keys, Object.values i Object.entries działają. Haczyk tkwi w typie klucza: Object.keys zwraca string[], a Object.entries zwraca [string, V][], nigdy twoją unię kluczy:

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 celowo zostawia klucze jako string: obiekt może mieć w czasie działania więcej właściwości, niż wymienia jego typ, więc obietnica Plan[] byłaby ogólnie niebezpieczna. Dla obiektu utworzonego z literału, jak seats, rzutowanie jest bezpieczne.

Budowanie Record z danych

Record to typowy wynik grupowania lub indeksowania tablicy. Zacznij od pustego obiektu o typie Record i wypełnij go:

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"] używa unii z interfejsu jako typu klucza, więc dodanie gatunku do Book sprawia, że byGenre wymaga nowego wpisu.

Record<string, unknown> i interfejsy

Record<string, unknown> to popularny typ dla "jakiegoś obiektu z kluczami tekstowymi". Przyjmuje literały obiektów i wartości otypowane aliasem type, ale interfejs zostaje odrzucony:

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

Interfejsy można rozszerzać przez łączenie deklaracji, więc TypeScript nie zakłada, że pasują do sygnatury indeksu; aliasów typów nie można ponownie otworzyć, więc type User = { name: string } by przeszedł. Typowe rozwiązania to przyjmować zamiast tego object (nadal możesz wywołać na nim Object.keys), uczynić funkcję generyczną (<T extends object>(obj: T)) albo zadeklarować User przez type (strona interface vs type omawia pozostałe różnice).

Record a sygnatura indeksu a Map

Wybieraj Record z kluczami z unii zawsze, gdy zbiór kluczy jest znany: to jedyna opcja, która sprawdza obecność każdego klucza. Dla otwartych kluczy tekstowych Record<string, V> i sygnatura indeksu są wymienne, a wiele projektów woli Record dla czytelności. Sięgnij po Map, gdy klucze są dodawane i usuwane w czasie działania, gdy klucze nie są stringami albo gdy potrzebujesz rozmiaru i kolejności wstawiania bez dodatkowej pracy.