readonly в TypeScript: свойства, Readonly<T> и массивы

readonly помечает свойство, которое можно задать один раз, при создании объекта, и никогда не переприсваивать. Readonly<T> применяет его к каждому свойству типа, а readonly T[] делает то же самое для массивов:

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 }

Последняя строка показывает самый важный факт о readonly: его проверяет компилятор, но во время выполнения он не соблюдается. Присваивание было ошибкой компиляции (здесь подавлено через @ts-expect-error), и всё же сгенерированный JavaScript его выполнил. Без подавления файл не скомпилировался бы, и именно там readonly делает свою работу.

Свойства readonly

Поставьте readonly перед именем свойства в интерфейсе, литерале типа или классе. Свойство можно инициализировать, но нельзя переприсвоить:

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 }

В классе поле readonly можно присвоить в его объявлении или в конструкторе, и больше нигде. Самая короткая форма это свойство-параметр, constructor(readonly id: string) {}, которое объявляет и присваивает поле за один шаг. Поля и конструкторы в целом описаны на странице о классах.

Readonly<T>: сразу все свойства

Readonly<T> это служебный тип, который помечает каждое свойство T как readonly. Он полезен для значений, которые передаются по коду, но не должны меняться, например для состояния приложения:

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 }

Сигнатура функции сообщает читателю, что addItem возвращает новое состояние, а не меняет старое, и компилятор заставляет функцию это соблюдать. Readonly<T> определён как сопоставленный тип { readonly [P in keyof T]: T[P] }.

Readonly-массивы: readonly T[] и ReadonlyArray<T>

readonly number[] и ReadonlyArray<number> это один и тот же тип. Они убирают все изменяющие методы (push, pop, shift, splice, sort, reverse, fill...) и запрещают присваивание по индексу. Неизменяющие методы остаются и возвращают обычные массивы:

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)

Принимать readonly T[] как параметр значит обещать вызывающему коду, что вы не будете менять его массив. На обратном направлении обычно и застревают: readonly-массив нельзя передать в функцию, которая принимает обычный T[], потому что она может его изменить.

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

Исправление: заставить sum принимать readonly number[], раз она ничего не меняет. Функции, которые только читают массив, всегда должны принимать readonly-тип; тогда они принимают оба вида. Если функция не ваша, передайте копию: sum([...prices]).

ReadonlyMap и ReadonlySet

У Map и множеств тоже есть readonly-версии. У ReadonlyMap<K, V> есть get, has, size, forEach и итераторы, но нет set, delete и clear; у ReadonlySet<T> нет add, delete и 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);

Класс часто хранит приватный изменяемый Map и открывает его через геттер с типом ReadonlyMap, чтобы внешний код мог читать данные, но не менять их через эту ссылку.

readonly поверхностный

readonly и Readonly<T> защищают только само свойство, а не объект или массив, на который оно указывает:

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> применяет себя к каждому вложенному объектному типу, а поскольку сопоставленный тип над типом массива даёт readonly-массив, members становится readonly string[]. Это по-прежнему обещание на уровне типов, а не защита во время выполнения.

Только при компиляции: изменение через другую ссылку

Readonly-тип определяет, что может делать одна ссылка. Другая ссылка на тот же объект, типизированная без readonly, может его изменить, и TypeScript даже позволяет присвоить readonly-тип изменяемому:

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

Присваивание mutable = settings компилируется, потому что TypeScript не учитывает свойства readonly, когда проверяет совместимость двух объектных типов; справочник TypeScript говорит об этом прямо и отмечает, что из-за этого readonly-свойства могут меняться через псевдонимы. С readonly-массивами иначе: ошибка TS4104 выше это именно такая проверка. Object.freeze действительно предотвращает изменения во время выполнения: сгенерированный код работает в строгом режиме, где запись в замороженное свойство выбрасывает TypeError. Как и readonly, Object.freeze поверхностный.

readonly, const, as const и Object.freeze

as const на литерале делает каждое свойство readonly на любой глубине и сохраняет литеральные типы; часто это самый простой способ получить глубоко readonly-значение:

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

const и readonly отвечают на разные вопросы: const не даёт имени указывать на что-то другое, readonly не даёт свойству меняться. Свойства объекта const всё ещё можно переприсваивать, если они не readonly.