re:re:actable
Урок 023 минуты чтения

Опциональные и readonly-поля в типах и интерфейсах

На этой странице
Кратко

Опциональное поле помечают ?: email?: string — свойство может отсутствовать, а его тип становится string | undefined. Неизменяемое поле помечают readonly: его нельзя переназначить после создания объекта. Обе проверки работают только на этапе компиляции. Для массовых изменений есть utility-типы Partial<T>, Required<T> и Readonly<T>.

Вопрос

Как задать опциональные поля в интерфейсе или типе? Как сделать поля неизменяемыми?

Опциональные поля

interface User {
  id: number;
  name: string;
  email?: string;           // может отсутствовать
  phone?: string | null;    // может отсутствовать или быть null
}
 
const anna: User = { id: 1, name: "Анна" }; // OK без email
 
function sendEmail(user: User) {
  user.email.toLowerCase();   // ошибка: 'user.email' is possibly 'undefined'
  user.email?.toLowerCase();  // OK
  if (user.email) {
    user.email.toLowerCase(); // OK — сужено до string
  }
}

? и | undefined — не одно и то же

type A = { email?: string };            // поле можно не указывать
type B = { email: string | undefined }; // поле обязательно, но может быть undefined
 
const a: A = {};          // OK
const b: B = {};          // ошибка: Property 'email' is missing
const b2: B = { email: undefined }; // OK

С флагом exactOptionalPropertyTypes запись { email: undefined } для email?: string станет ошибкой — поле либо отсутствует, либо string.

Readonly-поля

interface Order {
  readonly id: string;
  readonly createdAt: Date;
  status: "new" | "paid";
}
 
const order: Order = { id: "A-1", createdAt: new Date(), status: "new" };
 
order.status = "paid";  // OK
order.id = "B-2";       // ошибка: Cannot assign to 'id' because it is a read-only property
order.createdAt.setFullYear(2030); // OK — readonly поверхностный, объект Date можно менять

Utility-типы

type UserDraft = Partial<User>;        // все поля опциональны
type FullUser = Required<User>;        // все поля обязательны
type FrozenUser = Readonly<User>;      // все поля readonly
 
function updateUser(id: number, patch: Partial<Omit<User, "id">>) {}

Readonly-массивы и as const

const roles: readonly string[] = ["admin", "user"];
roles.push("guest"); // ошибка
 
const config = { api: "/api", retries: 3 } as const; // все поля readonly и литеральные

Что важно помнить

  • readonly и ? существуют только для компилятора: в runtime объект можно изменить, для настоящей заморозки нужен Object.freeze.
  • Readonly<T> поверхностный — для вложенных объектов пишут свой DeepReadonly<T>.
  • В React props по смыслу неизменяемы, поэтому их иногда типизируют Readonly<Props>.
  • Много опциональных полей часто сигнал, что тип описывает несколько разных состояний — лучше discriminated union.

Мини-шпаргалка

  • field?: T — может отсутствовать, тип T | undefined.
  • ? ≠ T | undefined: во втором случае поле обязательно.
  • readonly field: T — нельзя переназначить.
  • Partial, Required, Readonly — для всех полей сразу.
  • Проверки только на этапе компиляции.

Документация

TypeScript Handbook: Optional Properties, TypeScript Handbook: readonly Properties, TypeScript: exactOptionalPropertyTypes.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам