Diccionarios en TypeScript: index signatures, Record y Map

TypeScript no tiene una clase aparte para diccionarios o hashmaps. Un diccionario es o bien un objeto normal tipado con una firma de índice, { [key: string]: number }, o el mismo tipo escrito Record<string, number>, o bien un Map<string, number>. Los tres guardan valores por clave; se diferencian en los tipos de clave, en cómo se tipan las claves que faltan y en cómo se serializan.

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

Para claves string y datos con forma de JSON, lo habitual es un objeto con Record<string, T>. Para claves que no son strings, o para entradas que se añaden y se quitan todo el tiempo, usa un Map.

Firmas de índice

Una firma de índice, [key: KeyType]: ValueType, dice «cualquier clave de este tipo corresponde a un valor de este tipo». El nombre de la clave (key, name, userId) es solo documentación. Los tipos de clave pueden ser string, number, symbol, patrones de template literal o uniones de ellos.

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 convierte las claves numéricas en strings, así que un objeto { [id: number]: string } sigue teniendo claves string en tiempo de ejecución: Object.keys({ 1: "one" }) es [ '1' ]. La firma de índice numérica solo restringe cómo puedes indexarlo en TypeScript.

Record<K, V>

Record<string, V> es una forma abreviada de { [key: string]: V }. Con una unión de claves literales en lugar de string, se convierte en un diccionario fijo que debe contener todas las claves:

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

Omitir staging en urls es el error de compilación TS2741 (Property 'staging' is missing...), lo que convierte a Record con claves de unión en una tabla de búsqueda comprobada. Partial hace que cada valor sea number | undefined.

Map como hash map

Un Map acepta claves de cualquier tipo, mantiene el orden de inserción, tiene size y tipa con honestidad las claves que faltan: get devuelve V | undefined.

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

Comprobar si existe una clave

Hay varias comprobaciones, y no todas significan lo mismo:

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'");
}

El problema de las claves heredadas es la razón por la que claves que vienen del usuario, como "constructor" o "__proto__", hacen arriesgado usar objetos normales como diccionarios. Un Map no tiene esas claves.

El problema del tipo de las claves que faltan

En una firma de índice o en Record<string, T>, leer cualquier clave tiene tipo T, incluso una clave que no existe. El compilador te deja llamar a métodos sobre un valor que en tiempo de ejecución es undefined:

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);
}

La opción del compilador noUncheckedIndexedAccess lo arregla: con ella, colors["grass"] tiene tipo string | undefined y la llamada a toUpperCase es un error de compilación hasta que lo compruebes. No forma parte de strict, así que hay que activarla aparte en tsconfig.json; consulta el modo strict para ver las demás opciones que la acompañan. Un Map no tiene ese hueco, porque get siempre incluye undefined.

Añadir, borrar y recorrer

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 funciona con propiedades de una firma de índice. Sobre una propiedad con nombre obligatoria de un tipo objeto es el error de compilación TS2790, The operand of a 'delete' operator must be optional.

Cuál usar