TypeScript Dictionary: Index-Signaturen, Record und Map

TypeScript hat keine eigene Dictionary- oder Hashmap-Klasse. Ein Dictionary ist entweder ein einfaches Objekt mit Index-Signatur, { [key: string]: number }, derselbe Typ als Record<string, number> geschrieben, oder eine Map<string, number>. Alle drei speichern Werte unter Schlüsseln; sie unterscheiden sich bei den Schlüsseltypen, der Typisierung fehlender Schlüssel und der Serialisierung.

// 1. Index signature on an object
const ages: { [name: string]: number } = { ada: 36 };
ages["grace"] = 85;
ages.alan = 41;

// 2. Record: the same type, shorter to write
const prices: Record<string, number> = { tea: 2.5 };
prices["coffee"] = 3.2;

// 3. Map: a real hash map class
const stock = new Map<string, number>();
stock.set("apples", 3);

console.log(ages);            // { ada: 36, grace: 85, alan: 41 }
console.log(prices.coffee);   // 3.2
console.log(stock.get("apples")); // 3

Für String-Schlüssel und Daten in JSON-Form ist ein Objekt mit Record<string, T> die übliche Wahl. Für Schlüssel, die keine Strings sind, oder Einträge, die ständig hinzukommen und wegfallen, nimm eine Map.

Index-Signaturen

Eine Index-Signatur, [key: KeyType]: ValueType, sagt: „Jeder Schlüssel dieses Typs verweist auf einen Wert dieses Typs.“ Der Schlüsselname (key, name, userId) ist nur Dokumentation. Schlüsseltypen können string, number, symbol, Template-Literal-Muster oder Unions davon sein.

type User = { name: string; admin: boolean };

// The key name documents what the key is
const usersById: { [userId: string]: User } = {
    u1: { name: "Ada", admin: true },
};
usersById["u2"] = { name: "Grace", admin: false };

// Index signature plus named properties: named ones must fit the signature
type Scores = {
    total: number;
    [player: string]: number;
};
const scores: Scores = { total: 12, ada: 7, alan: 5 };

// Every value is checked against the value type
// @ts-expect-error: Type 'string' is not assignable to type 'number'.
scores.grace = "nine";

console.log(Object.keys(usersById), scores.total);

JavaScript wandelt Zahlenschlüssel in Strings um, also hat ein Objekt vom Typ { [id: number]: string } zur Laufzeit trotzdem String-Schlüssel: Object.keys({ 1: "one" }) ist [ '1' ]. Die Index-Signatur mit Zahl schränkt nur ein, wie du in TypeScript darauf zugreifen darfst.

Record<K, V>

Record<string, V> ist die Kurzform von { [key: string]: V }. Mit einer Union aus Literal-Schlüsseln statt string wird es zu einem festen Dictionary, das jeden Schlüssel enthalten muss:

// Open dictionary: any string key
const counts: Record<string, number> = {};
for (const word of ["a", "b", "a"]) {
    counts[word] = (counts[word] ?? 0) + 1;
}
console.log(counts); // { a: 2, b: 1 }

// Closed dictionary: exactly these keys, all required
type Env = "dev" | "staging" | "prod";
const urls: Record<Env, string> = {
    dev: "http://localhost:3000",
    staging: "https://staging.example.com",
    prod: "https://example.com",
};
console.log(urls.prod);

// Some of the keys: wrap in Partial
const overrides: Partial<Record<Env, number>> = { prod: 5 };
console.log(overrides.dev ?? "default"); // default

staging in urls wegzulassen ist der Compilerfehler TS2741 (Property 'staging' is missing...), was Record mit Union-Schlüsseln zu einer geprüften Lookup-Tabelle macht. Partial macht jeden Wert zu number | undefined.

Map als Hashmap

Eine Map akzeptiert Schlüssel jedes Typs, behält die Einfügereihenfolge, hat eine size und typisiert fehlende Schlüssel ehrlich: get gibt V | undefined zurück.

type Point = { x: number; y: number };

// Object keys work: compared by identity
const home: Point = { x: 0, y: 0 };
const labels = new Map<Point, string>([[home, "home"]]);
console.log(labels.get(home)); // home

// A string key built from the contents, for lookup by value
const grid = new Map<string, string>();
const key = (p: Point) => `${p.x},${p.y}`;
grid.set(key({ x: 2, y: 3 }), "tree");
console.log(grid.get(key({ x: 2, y: 3 }))); // tree
console.log(grid.get(key({ x: 9, y: 9 })) ?? "empty"); // empty
console.log(grid.size); // 1

Prüfen, ob ein Schlüssel existiert

Es gibt mehrere Prüfungen, und sie bedeuten nicht alle dasselbe:

const dict: Record<string, number> = { zero: 0, one: 1 };

console.log(Object.hasOwn(dict, "zero"));   // true: own property
console.log("zero" in dict);                // true
console.log("toString" in dict);            // true: inherited from Object.prototype!
console.log(Object.hasOwn(dict, "toString")); // false

console.log(dict["zero"] !== undefined);    // true
console.log(dict["zero"] ? "truthy" : "falsy"); // falsy: 0 is falsy, the key exists

const value = dict["two"];
if (value !== undefined) {
    console.log(value.toFixed(1)); // not reached
} else {
    console.log("no key 'two'");
}

Das Problem mit geerbten Schlüsseln ist der Grund, warum Schlüssel aus Benutzereingaben wie "constructor" oder "__proto__" einfache Objekte als Dictionaries riskant machen. Eine Map hat solche Schlüssel nicht.

Das Typproblem bei fehlenden Schlüsseln

Bei einer Index-Signatur oder Record<string, T> hat das Lesen jedes Schlüssels den Typ T, auch eines Schlüssels, der nicht existiert. Der Compiler lässt dich Methoden auf einem Wert aufrufen, der zur Laufzeit undefined ist:

const colors: Record<string, string> = { sky: "blue" };

const grass = colors["grass"]; // type: string, value: undefined
console.log(typeof grass);     // undefined

try {
    console.log(grass.toUpperCase()); // compiles, then throws
} catch (e) {
    if (e instanceof Error) console.log(e.message);
}

Die Compileroption noUncheckedIndexedAccess behebt das: Mit ihr hat colors["grass"] den Typ string | undefined, und der Aufruf von toUpperCase ist ein Compilerfehler, bis du prüfst. Sie gehört nicht zu strict und muss daher in tsconfig.json eigens eingeschaltet werden; die übrigen Flags daneben stehen unter Strict Mode. Eine Map hat diese Lücke nicht, da get immer undefined einschließt.

Hinzufügen, Entfernen und Iterieren

const inventory: Record<string, number> = { apples: 3, pears: 0 };

inventory["kiwis"] = 12;   // add or update
delete inventory["pears"]; // remove: allowed on index signatures

for (const [item, qty] of Object.entries(inventory)) { // [string, number]
    console.log(item, qty);
}

console.log(Object.keys(inventory).length); // 2 (the size)

// Map equivalents
const m = new Map(Object.entries(inventory)); // Map<string, number>
m.delete("apples");
console.log(m.size, [...m.keys()]); // 1 [ 'kiwis' ]

delete funktioniert bei Eigenschaften aus einer Index-Signatur. Bei einer benannten Pflichteigenschaft eines Objekttyps ist es der Compilerfehler TS2790, The operand of a 'delete' operator must be optional.

Welche Variante wofür