Map в TypeScript: Map<K, V>, get, set, has и перебор

Map в TypeScript это встроенный Map из JavaScript с типизированными ключами и значениями: Map<string, number> отображает строки в числа. Создайте его через new Map<K, V>(), а затем используйте set, get, has и delete. get возвращает V | undefined, потому что ключа может не быть.

const ages = new Map<string, number>();

ages.set("ada", 36);
ages.set("grace", 85).set("alan", 41); // set returns the map, so calls chain

console.log(ages.get("ada"));    // 36
console.log(ages.get("linus"));  // undefined
console.log(ages.has("grace"));  // true
console.log(ages.size);          // 3

ages.delete("alan");
console.log(ages); // Map(2) { 'ada' => 36, 'grace' => 85 }

// @ts-expect-error: Argument of type 'string' is not assignable to parameter of type 'number'.
ages.set("bob", "forty");

Именно аргументы типа делают Map полезным в TypeScript: каждый set проверяется, а каждый get возвращает тип значения. Последняя строка это ошибка компиляции (TS2345); @ts-expect-error позволяет блоку выполниться.

Эта страница о коллекции Map. Если вы искали array.map(), он разобран в последнем разделе.

Создание Map

Типы берутся из аргументов типа, из начальных записей или из аннотации. Начальные записи это массив кортежей [key, value] или что угодно ещё, что их выдаёт.

// 1. Type arguments, empty map
const scores = new Map<string, number[]>();

// 2. Inferred from entries: Map<string, number>
const prices = new Map([
    ["tea", 2.5],
    ["coffee", 3.2],
]);

// 3. From an object: Map<string, boolean>
const flags = new Map(Object.entries({ darkMode: true, beta: false }));

// 4. Keys and values of any type
type User = { id: number; name: string };
const lastSeen = new Map<User, Date>();
lastSeen.set({ id: 1, name: "Ada" }, new Date("2024-03-15T10:30:00Z"));

console.log(scores.size, prices.get("tea"), flags.get("beta"), lastSeen.size);

Две ловушки вывода типов:

• new Map() без аргументов типа и без записей это Map<any, any>. Ничего из того, что вы кладёте и достаёте, не проверяется. Всегда пишите new Map<K, V>().
• Записи с разными типами значений не выводят объединение. new Map([["a", 1], ["b", "x"]]) даёт ошибку TS2769 (No overload matches this call). Укажите тип: new Map<string, number | string>([...]).

get возвращает V | undefined

Map не может обещать, что ключ существует, поэтому get типизирован как V | undefined. В режиме strict нужно разобраться с undefined, прежде чем использовать значение как V:

// This does not compile: get may return undefined.
const stock = new Map<string, number>([["apples", 3]]);

const apples: number = stock.get("apples");
console.log(apples);

index.ts(4,7): error TS2322: Type 'number | undefined' is not assignable to type 'number'.
  Type 'undefined' is not assignable to type 'number'.

Способы исправить, от самого частого к самому редкому:

const stock = new Map<string, number>([["apples", 3]]);

// 1. A default value with ??
const pears = stock.get("pears") ?? 0;
console.log(pears); // 0

// 2. Store the result and check it
const apples = stock.get("apples");
if (apples !== undefined) {
    console.log(apples * 2); // 6: apples is number here
}

// 3. Update a counter in one line
stock.set("apples", (stock.get("apples") ?? 0) + 1);
console.log(stock.get("apples")); // 4

// has() does not narrow a later get():
if (stock.has("apples")) {
    const n = stock.get("apples"); // still number | undefined
    console.log(n);
}

TypeScript не запоминает, что has вернул true, когда вы потом вызываете get. Проверять результат get напрямую и короче, и безопасно. Non-null утверждение, stock.get("apples")!, убирает ошибку, но не защищает, если ключа нет.

Методы Map и их типы

Перебор Map

Map перебирается в порядке вставки. for...of по Map выдаёт кортежи [key, value] с типом [K, V].

const prices = new Map<string, number>([
    ["tea", 2.5],
    ["coffee", 3.2],
    ["juice", 4],
]);

for (const [item, price] of prices) {   // item: string, price: number
    console.log(`${item}: ${price.toFixed(2)}`);
}

prices.forEach((price, item) => {       // value first, then key
    console.log(item.toUpperCase(), price);
});

const items = [...prices.keys()];       // string[]
const total = [...prices.values()].reduce((a, b) => a + b, 0);
console.log(items, total);              // [ 'tea', 'coffee', 'juice' ] 9.7

// Sorted by value: sort the entries, build a new Map
const byPrice = new Map([...prices].sort((a, b) => b[1] - a[1]));
console.log([...byPrice.keys()]);       // [ 'juice', 'coffee', 'tea' ]

Запись по существующему ключу обновляет значение, но сохраняет его исходную позицию в порядке.

Ключи-объекты и подсчёт

Ключом может быть любое значение, включая объекты и массивы. Ключи сравниваются как ===: два объекта с одинаковым содержимым это разные ключи. Map также стандартный способ подсчитать или сгруппировать элементы.

const a = { id: 1 };
const b = { id: 1 };
const visits = new Map<object, number>([[a, 5]]);
console.log(visits.get(a), visits.get(b)); // 5 undefined: b is another object

// Counting words
const words = "the cat and the hat and the bat".split(" ");
const counts = new Map<string, number>();
for (const w of words) {
    counts.set(w, (counts.get(w) ?? 0) + 1);
}
console.log(counts); // Map(5) { 'the' => 3, 'cat' => 1, 'and' => 2, 'hat' => 1, 'bat' => 1 }

// Grouping into arrays
const byLength = new Map<number, string[]>();
for (const w of new Set(words)) {
    const group = byLength.get(w.length) ?? [];
    group.push(w);
    byLength.set(w.length, group);
}
console.log(byLength); // Map(1) { 3 => [ 'the', 'cat', 'and', 'hat', 'bat' ] }

Чтобы использовать ключ по содержимому объекта, получите из него строковый или числовой ключ, например user.id или `${x},${y}`.

Map, объект или Record

Простое правило: Map для коллекции, ключи которой являются данными (id пользователей, слова, записи кэша) и меняются во время выполнения; объектный тип или Record для фиксированного набора известных ключей и для всего, что идёт в JSON или из него. На странице словарь индексные сигнатуры, Record и Map сравниваются для поиска по строковым ключам.

Преобразование Map в объект и JSON

Записи Map не являются свойствами, поэтому JSON.stringify их не видит. Преобразуйте через Object.fromEntries и Object.entries:

const settings = new Map<string, string | number>([
    ["theme", "dark"],
    ["fontSize", 14],
]);

console.log(JSON.stringify(settings)); // {}

const obj = Object.fromEntries(settings); // { [k: string]: string | number }
const json = JSON.stringify(obj);
console.log(json); // {"theme":"dark","fontSize":14}

// And back again
const restored = new Map(Object.entries(JSON.parse(json) as Record<string, string | number>));
console.log(restored.get("theme")); // dark

JSON.parse возвращает any, поэтому as Record<...> указывает, какими данные должны быть. Это не проверка во время выполнения; прежде чем доверять такому типу, проверяйте ненадёжный JSON.

Типизация array.map()

Многие, кто ищет «typescript map», имеют в виду метод массива, который преобразует каждый элемент и возвращает новый массив. Его тип выводится из колбэка, так что аннотации нужны редко:

type User = { id: number; first: string; last: string };
const users: User[] = [
    { id: 1, first: "Ada", last: "Lovelace" },
    { id: 2, first: "Alan", last: "Turing" },
];

const names = users.map((u) => `${u.first} ${u.last}`); // string[]
const ids = users.map((u) => u.id);                     // number[]

// An explicit result type, checked against what the callback returns
type Option = { value: number; label: string };
const options = users.map((u): Option => ({ value: u.id, label: u.first }));

// With the index
const numbered = users.map((u, i) => `${i + 1}. ${u.first}`);

console.log(names, ids);
console.log(options);
console.log(numbered);

Аннотация возвращаемого типа колбэка ((u): Option => ...) самый понятный способ указать тип результата: пропущенное или написанное с ошибкой свойство в возвращаемом объекте тогда становится ошибкой компиляции прямо в колбэке.