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

Partial, Required и Readonly

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

Partial<T> делает все свойства типа необязательными, Required<T> — обязательными (убирает ?), Readonly<T> — доступными только для чтения. Все три — mapped types, которые меняют модификаторы свойств, и все работают поверхностно: вложенные объекты не затрагиваются.

Вопрос

Что делают utility-типы Partial, Required и Readonly? Как они устроены и где применяются?

Partial

type User = {
  id: number;
  name: string;
  email: string;
};
 
type UserPatch = Partial<User>;
// { id?: number; name?: string; email?: string }
 
function updateUser(id: number, patch: Partial<Omit<User, "id">>) {
  return api.patch(`/users/${id}`, patch);
}
 
updateUser(1, { name: "Анна" }); // остальные поля можно не передавать

Типичные применения: PATCH-запросы, черновики форм, объекты настроек со значениями по умолчанию:

const defaults: Settings = { theme: "light", pageSize: 20 };
function createSettings(overrides: Partial<Settings> = {}): Settings {
  return { ...defaults, ...overrides };
}

Required

type Config = {
  apiUrl?: string;
  timeout?: number;
};
 
type ResolvedConfig = Required<Config>;
// { apiUrl: string; timeout: number }
 
function resolve(config: Config): ResolvedConfig {
  return { apiUrl: config.apiUrl ?? "/api", timeout: config.timeout ?? 5000 };
}

Удобно, когда после применения значений по умолчанию все поля гарантированно заданы.

Readonly

type Point = Readonly<{ x: number; y: number }>;
 
const p: Point = { x: 1, y: 2 };
p.x = 5; // ошибка: Cannot assign to 'x' because it is a read-only property
 
function render(props: Readonly<Props>) {} // props не должны меняться

Readonly<T[]> или ReadonlyArray<T> — для массивов.

Как они устроены

type MyPartial<T> = { [K in keyof T]?: T[K] };
type MyRequired<T> = { [K in keyof T]-?: T[K] };      // -? удаляет модификатор
type MyReadonly<T> = { readonly [K in keyof T]: T[K] };
type Mutable<T> = { -readonly [K in keyof T]: T[K] };  // обратная операция

Глубокие версии

type DeepPartial<T> = {
  [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
};
 
type DeepReadonly<T> = {
  readonly [K in keyof T]: T[K] extends object ? DeepReadonly<T[K]> : T[K];
};

Встроенных глубоких версий нет; для массивов, Date и функций их нужно дорабатывать — или взять из библиотеки type-fest.

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

  • Все три типа поверхностные: Partial<{ address: { city: string } }> не делает city необязательным.
  • Partial для данных из формы удобен, но перед отправкой проверьте, что обязательные поля заполнены, — иначе ошибки уйдут в runtime.
  • Readonly — проверка компилятора; объект в runtime всё равно можно изменить.
  • Комбинации: Partial<Pick<User, "name" | "email">>, Required<Pick<Config, "apiUrl">> & Config.

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

  • Partial<T> — все поля ?.
  • Required<T> — все поля обязательны (-?).
  • Readonly<T> — все поля readonly.
  • Поверхностные, глубокие версии — вручную или type-fest.
  • Основаны на mapped types.

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

TypeScript: Partial, TypeScript: Required, TypeScript: Readonly.

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

Поиск

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