readonly em TypeScript: propriedades, Readonly<T> e arrays

readonly marca uma propriedade que pode ser definida uma vez, quando o objeto é criado, e nunca reatribuída. Readonly<T> aplica isso a toda propriedade de um tipo, e readonly T[] faz o mesmo para arrays:

interface Point {
  readonly x: number;
  readonly y: number;
}

const origin: Point = { x: 0, y: 0 };
// @ts-expect-error: Cannot assign to 'x' because it is a read-only property
origin.x = 5;

const config: Readonly<{ host: string; port: number }> = { host: "localhost", port: 8080 };
const ports: readonly number[] = [80, 443];

console.log(config.host, ports.length); // localhost 2
console.log(origin);                    // { x: 5, y: 0 }

A última linha mostra o fato mais importante sobre readonly: ele é verificado pelo compilador, não imposto em tempo de execução. A atribuição foi um erro de compilação (suprimido aqui com @ts-expect-error), mas o JavaScript gerado a executou mesmo assim. Sem a supressão, o arquivo não compilaria, e é aí que readonly faz o seu trabalho.

Propriedades readonly

Coloque readonly antes do nome de uma propriedade em uma interface, um type literal ou uma classe. A propriedade pode ser inicializada, mas não reatribuída:

class Invoice {
  readonly id: string;
  readonly createdAt = "2024-03-15";
  total = 0;

  constructor(id: string) {
    this.id = id; // allowed: the constructor may initialize readonly fields
  }

  add(amount: number) {
    this.total += amount; // fine: total is not readonly
    // this.id = "x" would be error TS2540: Cannot assign to 'id' because it is a read-only property.
  }
}

const inv = new Invoice("INV-7");
inv.add(19.5);
console.log(inv); // Invoice { id: 'INV-7', createdAt: '2024-03-15', total: 19.5 }

Em uma classe, um campo readonly pode ser atribuído na declaração ou no construtor, e em nenhum outro lugar. A forma mais curta é uma parameter property, constructor(readonly id: string) {}, que declara e atribui o campo em um passo só. A página de classes cobre campos e construtores em geral.

Readonly<T>: todas as propriedades de uma vez

Readonly<T> é um utility type que marca toda propriedade de T como readonly. Ele é útil para valores que você repassa mas que não devem mudar, como o estado de uma aplicação:

interface State {
  user: string;
  cart: string[];
  total: number;
}

function addItem(state: Readonly<State>, item: string, price: number): State {
  // state.total += price would be error TS2540
  return { ...state, cart: [...state.cart, item], total: state.total + price };
}

const s0: State = { user: "ada", cart: [], total: 0 };
const s1 = addItem(s0, "book", 12);
const s2 = addItem(s1, "pen", 2);

console.log(s0.cart, s2); // [] { user: 'ada', cart: [ 'book', 'pen' ], total: 14 }

A assinatura da função diz a quem lê que addItem retorna um estado novo em vez de alterar o antigo, e o compilador cobra isso da função. Readonly<T> é definido como o mapped type { readonly [P in keyof T]: T[P] }.

Arrays readonly: readonly T[] e ReadonlyArray<T>

readonly number[] e ReadonlyArray<number> são o mesmo tipo. Eles removem todo método que modifica (push, pop, shift, splice, sort, reverse, fill...) e proíbem a atribuição por índice. Os métodos que não modificam continuam lá e retornam arrays comuns:

const scores: readonly number[] = [42, 7, 19];

const doubled = scores.map((s) => s * 2);        // number[] (a new, mutable array)
const sorted = [...scores].sort((a, b) => a - b); // copy first, then sort the copy
const top = scores.slice(0, 2);

// @ts-expect-error: Property 'push' does not exist on type 'readonly number[]'
scores.push(1);

console.log(doubled, sorted, top); // [ 84, 14, 38 ] [ 7, 19, 42 ] [ 42, 7 ]
console.log(scores);               // [ 42, 7, 19, 1 ]  (push ran: types are erased)

Receber readonly T[] como parâmetro é uma promessa para quem chama de que você não vai modificar o array dele. A outra direção é onde as pessoas travam: um array readonly não pode ser passado para uma função que recebe um T[] comum, porque essa função poderia modificá-lo.

// This does not compile: a readonly array cannot go where a mutable one is expected
function sum(values: number[]): number {
  return values.reduce((a, b) => a + b, 0);
}

const prices: readonly number[] = [3, 4, 5];
console.log(sum(prices));

index.ts(7,17): error TS4104: The type 'readonly number[]' is 'readonly' and cannot be assigned to the mutable type 'number[]'.

A correção é mudar sum para aceitar readonly number[], já que ela não modifica nada. Funções que só leem um array devem sempre receber o tipo readonly; assim elas aceitam os dois tipos de array. Se a função não é sua, passe uma cópia: sum([...prices]).

ReadonlyMap e ReadonlySet

Maps e sets também têm versões readonly. ReadonlyMap<K, V> tem get, has, size, forEach e os iteradores, mas não tem set, delete nem clear; ReadonlySet<T> não tem add, delete nem clear:

const prices: ReadonlyMap<string, number> = new Map([
  ["tea", 2.5],
  ["coffee", 3.2],
]);
const admins: ReadonlySet<string> = new Set(["ada"]);

console.log(prices.get("tea"), prices.size, admins.has("ada")); // 2.5 2 true

// @ts-expect-error: Property 'set' does not exist on type 'ReadonlyMap<string, number>'
prices.set("juice", 4);

Uma classe muitas vezes guarda um Map mutável privado e o expõe por um getter com tipo ReadonlyMap, para que o código de fora possa ler os dados mas não alterá-los por essa referência.

readonly é raso

readonly e Readonly<T> protegem só a propriedade em si, não o objeto ou o array para o qual ela aponta:

interface Team {
  readonly name: string;
  readonly members: string[];
  readonly lead: { name: string };
}

const team: Readonly<Team> = { name: "Core", members: ["ada"], lead: { name: "ada" } };

team.members.push("linus"); // allowed: the array itself is not readonly
team.lead.name = "linus";   // allowed: only the lead property is readonly
// team.members = [] would be error TS2540

console.log(team); // { name: 'Core', members: [ 'ada', 'linus' ], lead: { name: 'linus' } }

type DeepReadonly<T> = T extends (...args: any[]) => unknown ? T
  : T extends object ? { readonly [K in keyof T]: DeepReadonly<T[K]> }
  : T;

const frozenTeam: DeepReadonly<Team> = team;
// @ts-expect-error: Property 'push' does not exist on type 'readonly string[]'
frozenTeam.members.push("grace");

DeepReadonly<T> se aplica a todo tipo de objeto aninhado, e como um mapped type sobre um tipo array produz um array readonly, members vira readonly string[]. Continua sendo uma promessa no nível dos tipos, não proteção em tempo de execução.

Só em tempo de compilação: mutação por outra referência

Um tipo readonly controla o que uma referência pode fazer. Outra referência ao mesmo objeto, tipada sem readonly, pode alterá-lo, e o TypeScript até permite atribuir um tipo readonly a um mutável:

interface Settings {
  readonly theme: string;
}

const settings: Settings = { theme: "dark" };
const mutable: { theme: string } = settings; // allowed, no error
mutable.theme = "light";

console.log(settings.theme); // light

// Runtime protection needs Object.freeze
const locked = Object.freeze({ theme: "dark" }); // typed Readonly<{ theme: "dark" }>
try {
  (locked as { theme: string }).theme = "light";
} catch (e) {
  console.log((e as Error).name); // TypeError
}
console.log(locked.theme); // dark

A atribuição mutable = settings compila porque o TypeScript não leva em conta propriedades readonly quando verifica se dois tipos de objeto são compatíveis; o handbook do TypeScript diz isso diretamente e observa que, por isso, propriedades readonly podem mudar por aliasing. Arrays readonly são diferentes: o erro TS4104 acima é exatamente essa verificação. Object.freeze realmente impede mudanças em tempo de execução: o código gerado roda em strict mode, onde escrever em uma propriedade congelada lança um TypeError. Assim como readonly, Object.freeze é raso.

readonly, const, as const e Object.freeze

as const em um literal torna toda propriedade readonly em todos os níveis e mantém os literal types, o que muitas vezes é o jeito mais fácil de obter um valor profundamente readonly:

const theme = { mode: "dark", sizes: [12, 14] } as const;
// { readonly mode: "dark"; readonly sizes: readonly [12, 14] }

const e readonly respondem a perguntas diferentes: const impede que o nome aponte para outro lugar, readonly impede que uma propriedade mude. As propriedades de um objeto const ainda podem ser reatribuídas, a menos que sejam readonly.