Dicionário em TypeScript: index signatures, Record e Map

O TypeScript não tem uma classe separada de dicionário ou hashmap. Um dicionário é um objeto comum tipado com uma index signature, { [key: string]: number }, o mesmo tipo escrito como Record<string, number>, ou um Map<string, number>. Os três guardam valores por chave; eles diferem nos tipos de chave, na forma como chaves ausentes são tipadas e na serialização.

// 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 chaves string e dados no formato de JSON, um objeto com Record<string, T> é a escolha usual. Para chaves que não são strings, ou entradas adicionadas e removidas o tempo todo, use um Map.

Index signatures

Uma index signature, [key: KeyType]: ValueType, diz "qualquer chave deste tipo mapeia para um valor deste tipo". O nome da chave (key, name, userId) serve só como documentação. Os tipos de chave podem ser string, number, symbol, padrões de template literal ou unions desses.

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

Chaves numéricas são convertidas em strings pelo JavaScript, então um objeto { [id: number]: string } continua tendo chaves string em tempo de execução: Object.keys({ 1: "one" }) é [ '1' ]. A index signature numérica só restringe como você pode indexar no TypeScript.

Record<K, V>

Record<string, V> é uma forma curta de { [key: string]: V }. Com uma union de chaves literais no lugar de string, ele vira um dicionário fixo que precisa conter todas as chaves:

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

Deixar staging fora de urls é o erro de compilação TS2741 (Property 'staging' is missing...), o que faz de Record com chaves union uma tabela de consulta verificada. Partial torna cada valor number | undefined.

Map como hash map

Um Map aceita chaves de qualquer tipo, mantém a ordem de inserção, tem size e tipa chaves ausentes com honestidade: get retorna 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

Verificando se uma chave existe

Existem várias verificações, e elas não significam todas a mesma coisa:

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

O problema das chaves herdadas é o motivo pelo qual chaves vindas do usuário, como "constructor" ou "__proto__", tornam objetos comuns arriscados como dicionários. Um Map não tem esse tipo de chave.

O problema do tipo de chave ausente

Em uma index signature ou em Record<string, T>, ler qualquer chave tem o tipo T, mesmo uma chave que não existe. O compilador deixa você chamar métodos em um valor que é undefined em tempo de execução:

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

A opção de compilador noUncheckedIndexedAccess resolve isso: com ela, colors["grass"] tem o tipo string | undefined e a chamada a toUpperCase é erro de compilação até você fazer a verificação. Ela não faz parte de strict, então precisa ser ativada separadamente no tsconfig.json; veja strict mode para as outras flags ao lado dela. Um Map não tem essa brecha, já que get sempre inclui undefined.

Adicionando, removendo e iterando

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 em propriedades de index signature. Em uma propriedade nomeada obrigatória de um tipo de objeto, é o erro de compilação TS2790, The operand of a 'delete' operator must be optional.

Qual usar