Array em TypeScript: tipos, array de objetos, map e filter

Um tipo de array em TypeScript é o tipo do elemento seguido de []: string[] é um array de strings, number[] um array de números. A grafia genérica Array<string> é o mesmo tipo. Depois que um array está tipado, todo elemento que você adiciona e todo elemento que você lê tem esse tipo.

const names: string[] = ["Ada", "Grace"];
const scores: Array<number> = [90, 85, 72]; // same as number[]

names.push("Alan");
// @ts-expect-error: Argument of type 'number' is not assignable to parameter of type 'string'.
names.push(42);

const first: string = names[0];
const total = scores.reduce((sum, s) => sum + s, 0); // number

console.log(names, first, total);

A linha com @ts-expect-error é um erro de compilação (TS2345). Aqui ela está marcada como esperada para que o bloco ainda rode e, como os tipos são apagados, o 42 é mesmo adicionado em tempo de execução: a saída mostra isso.

string[] vs Array<string>

Escolha um estilo para o projeto. A regra array-type do typescript-eslint usa T[] por padrão.

Arrays de objetos

Descreva o elemento com um type alias ou uma interface e depois use Type[]. Tudo o que sai do array é verificado contra esse formato.

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

const users: User[] = [
    { id: 1, name: "Ada", admin: true },
    { id: 2, name: "Grace", admin: false },
    { id: 3, name: "Alan", admin: false },
];

users.push({ id: 4, name: "Linus", admin: false });

const admins = users.filter((u) => u.admin);       // User[]
const names = users.map((u) => u.name);            // string[]
const byId = users.find((u) => u.id === 2);        // User | undefined

console.log(admins.length, names);
console.log(byId?.name ?? "not found"); // Grace

Um objeto literal adicionado a users precisa corresponder exatamente a User: um admin ausente ou uma propriedade com nome errado é erro de compilação.

map, filter, reduce e find tipados

Os métodos de array são genéricos, então seus resultados carregam tipos. O que cada método faz em tempo de execução está na página de métodos de array do JavaScript; os tipos são o que o TypeScript acrescenta:

const prices = [4.5, 12, 8.25];

const labels = prices.map((p) => `$${p.toFixed(2)}`); // string[]
console.log(labels); // [ '$4.50', '$12.00', '$8.25' ]

const expensive = prices.find((p) => p > 100); // number | undefined
console.log(expensive ?? "none"); // none

// reduce's result type comes from the initial value,
// or from a type argument when the initial value is just {}
const byInitial = ["apple", "avocado", "banana"].reduce<Record<string, string[]>>(
    (acc, word) => {
        (acc[word[0]] ??= []).push(word);
        return acc;
    },
    {},
);
console.log(byInitial); // { a: [ 'apple', 'avocado' ], b: [ 'banana' ] }

// filter narrows when the callback is a type check
const raw = [1, undefined, 3, undefined];
const defined = raw.filter((n) => n !== undefined); // number[]
console.log(defined); // [ 1, 3 ]

O último exemplo funciona porque o TypeScript (desde a versão 5.5) infere que (n) => n !== undefined é um type predicate, então filter retorna number[] em vez de (number | undefined)[]. Para verificações que ele não consegue inferir, escreva o predicate você mesmo: filter((x): x is User => x !== null).

Arrays com mais de um tipo

Um tipo de elemento union permite misturar. Uma union de tipos de array não permite:

const mixed: (string | number)[] = [1, "two", 3]; // each element: string or number

let ids: string[] | number[] = [1, 2, 3]; // all numbers...
ids = ["a", "b"];                          // ...or all strings

// @ts-expect-error: (string | number)[] is not assignable to string[] | number[]
ids = [1, "b"];

for (const item of mixed) {
    // narrow each element before using type-specific methods
    console.log(typeof item === "string" ? item.toUpperCase() : item.toFixed(1));
}

Quando as posições têm tipos fixos, como um par [name, age], use uma tupla: [string, number] sabe que o índice 0 é uma string e o índice 1 é um número, o que (string | number)[] não sabe.

Arrays readonly

readonly T[] remove todo método que modifica o array. Use em parâmetros que a função não deve alterar e em constantes.

// This does not compile: readonly arrays have no push.
function average(values: readonly number[]): number {
    values.push(0);
    return values.reduce((a, b) => a + b, 0) / values.length;
}

console.log(average([2, 4, 6]));

index.ts(3,12): error TS2339: Property 'push' does not exist on type 'readonly number[]'.

Apague a linha do push e o bloco imprime 4. Um number[] mutável sempre pode ser passado onde se espera readonly number[], então parâmetros readonly não custam nada para quem chama. A verificação só existe em tempo de compilação: em tempo de execução é um array comum. Para ordenar um array readonly, ordene uma cópia: [...values].sort().

A armadilha do includes com arrays de literais

as const transforma um array em uma tupla readonly de tipos literais. Isso é útil para uma lista de valores permitidos, mas aí o includes dela só aceita esses literais:

const COLORS = ["red", "green", "blue"] as const;
type Color = (typeof COLORS)[number]; // "red" | "green" | "blue"

function isColor(value: string): value is Color {
    // COLORS.includes(value) is error TS2345: 'string' is not assignable
    // to '"blue" | "green" | "red"'. Widen the array for the check:
    return (COLORS as readonly string[]).includes(value);
}

const input: string = "green";
if (isColor(input)) {
    const c: Color = input; // narrowed to Color
    console.log("valid color:", c);
}
console.log(isColor("purple")); // false

Colocar a verificação dentro de um type guard (value is Color) faz o alargamento acontecer uma vez só, e quem chama recebe de volta um valor estreitado.

Índices e arrays vazios

Ler arr[i] dá o tipo T, mesmo quando i está fora do intervalo e o valor em tempo de execução é undefined. at(i) tem o tipo T | undefined, e a opção de compilador noUncheckedIndexedAccess faz o acesso por índice simples retornar T | undefined também.

const queue: string[] = []; // annotate empty arrays

const head = queue[0];     // type string, value undefined
const last = queue.at(-1); // type string | undefined

console.log(head, last);            // undefined undefined
console.log(last?.toUpperCase());   // undefined, safely

queue[0].toUpperCase() compilaria e depois lançaria um TypeError em tempo de execução. Prefira at(), uma verificação de tamanho ou noUncheckedIndexedAccess quando um índice pode não existir.