Dizionario in TypeScript: index signature, Record e Map

TypeScript non ha una classe dizionario o hashmap separata. Un dizionario è un oggetto semplice tipizzato con una index signature, { [key: string]: number }, lo stesso tipo scritto Record<string, number>, oppure una Map<string, number>. Tutti e tre memorizzano valori per chiave; differiscono per i tipi di chiave, per come sono tipizzate le chiavi mancanti e per come vengono serializzati.

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

Per chiavi stringa e dati in forma JSON, un oggetto con Record<string, T> è la scelta abituale. Per chiavi non stringa, o per voci aggiunte e rimosse di continuo, usa una Map.

Index signature

Una index signature, [key: KeyType]: ValueType, dice "qualsiasi chiave di questo tipo corrisponde a un valore di questo tipo". Il nome della chiave (key, name, userId) è solo documentazione. I tipi di chiave possono essere string, number, symbol, pattern di template literal o union di questi.

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

Le chiavi numeriche vengono convertite in stringhe da JavaScript, quindi un oggetto { [id: number]: string } ha comunque chiavi stringa a runtime: Object.keys({ 1: "one" }) è [ '1' ]. La index signature numerica limita solo il modo in cui puoi indicizzarlo in TypeScript.

Record<K, V>

Record<string, V> è la forma breve di { [key: string]: V }. Con una union di chiavi letterali al posto di string, diventa un dizionario fisso che deve contenere ogni chiave:

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

Omettere staging da urls è l'errore di compilazione TS2741 (Property 'staging' is missing...), e questo rende Record con chiavi union una tabella di lookup controllata. Partial rende ogni valore number | undefined.

Map come hash map

Una Map accetta chiavi di qualsiasi tipo, mantiene l'ordine di inserimento, ha una size e tipizza onestamente le chiavi mancanti: get restituisce 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

Verificare se una chiave esiste

Esistono diversi controlli, e non significano tutti la stessa cosa:

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

Il problema delle chiavi ereditate è il motivo per cui le chiavi fornite dagli utenti, come "constructor" o "__proto__", rendono rischiosi gli oggetti semplici come dizionari. Una Map non ha chiavi del genere.

Il problema del tipo delle chiavi mancanti

Su una index signature o su Record<string, T>, leggere qualsiasi chiave ha tipo T, anche una chiave che non esiste. Il compilatore ti lascia chiamare metodi su un valore che a runtime è 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);
}

L'opzione del compilatore noUncheckedIndexedAccess risolve il problema: con essa, colors["grass"] ha tipo string | undefined e la chiamata a toUpperCase è un errore di compilazione finché non lo controlli. Non fa parte di strict, quindi va attivata separatamente in tsconfig.json; vedi strict mode per gli altri flag che le stanno accanto. Una Map non ha questa lacuna, perché get include sempre undefined.

Aggiungere, rimuovere e iterare

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 funziona sulle proprietà di una index signature. Su una proprietà nominata obbligatoria di un tipo oggetto è l'errore di compilazione TS2790, The operand of a 'delete' operator must be optional.

Quale usare