readonly w TypeScript: właściwości, Readonly<T> i tablice

readonly oznacza właściwość, którą można ustawić raz, przy tworzeniu obiektu, i nigdy więcej nie przypisać. Readonly<T> stosuje to do każdej właściwości typu, a readonly T[] robi to samo dla tablic:

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 }

Ostatnia linia pokazuje najważniejszy fakt o readonly: sprawdza go kompilator, ale nie jest egzekwowany w czasie działania. Przypisanie było błędem kompilacji (tu wyciszonym przez @ts-expect-error), a mimo to wygenerowany JavaScript je wykonał. Bez wyciszenia plik by się nie skompilował i właśnie tam readonly spełnia swoje zadanie.

Właściwości readonly

Postaw readonly przed nazwą właściwości w interfejsie, literale typu lub klasie. Właściwość można zainicjalizować, ale nie ponownie przypisać:

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 }

W klasie pole readonly można przypisać w jego deklaracji albo w konstruktorze i nigdzie indziej. Najkrótsza forma to parameter property, constructor(readonly id: string) {}, która deklaruje i przypisuje pole w jednym kroku. Strona o klasach omawia pola i konstruktory ogólnie.

Readonly<T>: wszystkie właściwości naraz

Readonly<T> to typ narzędziowy, który oznacza każdą właściwość T jako readonly. Przydaje się dla wartości, które przekazujesz dalej, ale których nie należy zmieniać, na przykład stanu aplikacji:

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 }

Sygnatura funkcji mówi czytelnikowi, że addItem zwraca nowy stan zamiast zmieniać stary, a kompilator pilnuje, żeby funkcja się tego trzymała. Readonly<T> jest zdefiniowany jako typ mapowany { readonly [P in keyof T]: T[P] }.

Tablice tylko do odczytu: readonly T[] i ReadonlyArray<T>

readonly number[] i ReadonlyArray<number> to ten sam typ. Usuwają każdą metodę mutującą (push, pop, shift, splice, sort, reverse, fill...) i zabraniają przypisania przez indeks. Metody niemutujące zostają i zwracają zwykłe tablice:

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)

Przyjmowanie readonly T[] jako parametru to obietnica dla wywołujących, że nie zmodyfikujesz ich tablicy. W drugą stronę ludzie często utykają: tablicy readonly nie można przekazać do funkcji przyjmującej zwykłe T[], bo ta funkcja mogłaby ją zmienić.

// 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[]'.

Rozwiązanie to zmienić sum tak, by przyjmowała readonly number[], bo niczego nie mutuje. Funkcje, które tylko czytają tablicę, powinny zawsze przyjmować typ readonly; wtedy akceptują oba rodzaje. Jeśli funkcja nie jest twoja, przekaż kopię: sum([...prices]).

ReadonlyMap i ReadonlySet

Mapy i zbiory też mają wersje tylko do odczytu. ReadonlyMap<K, V> ma get, has, size, forEach i iteratory, ale nie ma set, delete ani clear; ReadonlySet<T> nie ma add, delete ani 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);

Klasa często trzyma prywatną mutowalną Map i udostępnia ją przez getter o typie ReadonlyMap, więc kod z zewnątrz może czytać dane, ale nie może ich zmienić przez tę referencję.

readonly jest płytkie

readonly i Readonly<T> chronią tylko samą właściwość, a nie obiekt lub tablicę, na którą wskazuje:

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> stosuje się do każdego zagnieżdżonego typu obiektowego, a ponieważ typ mapowany na typie tablicy daje tablicę readonly, members staje się readonly string[]. To nadal obietnica na poziomie typów, a nie ochrona w czasie działania.

Tylko podczas kompilacji: mutacja przez inną referencję

Typ readonly kontroluje, co może zrobić jedna referencja. Inna referencja do tego samego obiektu, otypowana bez readonly, może go zmienić, a TypeScript pozwala nawet przypisać typ readonly do mutowalnego:

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

Przypisanie mutable = settings się kompiluje, bo TypeScript nie bierze pod uwagę właściwości readonly, gdy sprawdza, czy dwa typy obiektowe są zgodne; handbook TypeScriptu mówi to wprost i zauważa, że właściwości readonly mogą się przez to zmieniać przez aliasy. Z tablicami readonly jest inaczej: błąd TS4104 wyżej to właśnie takie sprawdzenie. Object.freeze naprawdę blokuje zmiany w czasie działania: wygenerowany kod działa w trybie strict, w którym zapis do zamrożonej właściwości rzuca TypeError. Tak jak readonly, Object.freeze jest płytkie.

readonly, const, as const i Object.freeze

as const na literale czyni każdą właściwość readonly na każdym poziomie i zachowuje typy literałowe, co często jest najprostszym sposobem na głęboko readonly wartość:

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

const i readonly odpowiadają na różne pytania: const nie pozwala nazwie wskazywać gdzie indziej, readonly nie pozwala zmienić właściwości. Właściwości obiektu const nadal można ponownie przypisać, chyba że są readonly.