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

Object.defineProperty и readonly-свойства

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

Object.defineProperty(obj, key, descriptor) создает или настраивает свойство с флагами: writable (можно ли менять значение), enumerable (видно ли в Object.keys и for...in), configurable (можно ли удалить и перенастроить) или с аксессорами get/set. Свойство только для чтения получают через writable: false, геттер без сеттера или Object.freeze.

Вопрос

Что делает Object.defineProperty()? Какие флаги есть у свойства и как сделать свойство только для чтения?

Дескриптор свойства

Каждое свойство имеет дескриптор. У свойства-данных — value и writable, у аксессора — get и set. Общие флаги — enumerable и configurable.

const user = { name: "Анна" };
 
Object.getOwnPropertyDescriptor(user, "name");
// { value: "Анна", writable: true, enumerable: true, configurable: true }

При обычном присваивании все флаги true. При defineProperty неуказанные флаги по умолчанию false.

Readonly-свойство

const config = {};
 
Object.defineProperty(config, "apiUrl", {
  value: "https://api.example.com",
  writable: false,
  enumerable: true,
  configurable: false,
});
 
config.apiUrl = "другой"; // молча игнорируется; в strict mode — TypeError
delete config.apiUrl;     // false; в strict mode — TypeError

Другие способы сделать свойство только для чтения:

const order = {
  items: [100, 200],
  get total() {                     // геттер без сеттера
    return this.items.reduce((a, b) => a + b, 0);
  },
};
 
const frozen = Object.freeze({ id: 1 }); // все свойства readonly (поверхностно)
 
class Account {
  #id;
  constructor(id) { this.#id = id; }
  get id() { return this.#id; }     // readonly снаружи
}

В TypeScript readonly id: number проверяется только на этапе компиляции — в runtime свойство изменяемо.

Флаги

Флагfalse означает
writableзначение нельзя изменить присваиванием
enumerableсвойство не видно в Object.keys, for...in, JSON.stringify, spread
configurableсвойство нельзя удалить и нельзя менять его флаги (кроме writable: true → false)
const product = { title: "Чайник" };
Object.defineProperty(product, "internalId", { value: 42, enumerable: false });
 
Object.keys(product);       // ["title"]
JSON.stringify(product);    // '{"title":"Чайник"}'
product.internalId;         // 42

Так скрыты методы встроенных прототипов: toString не виден в for...in.

Несколько свойств и копия с флагами

Object.defineProperties(obj, {
  a: { value: 1, writable: true },
  b: { get() { return this.a * 2; } },
});
 
// клонирование с сохранением флагов и аксессоров
const clone = Object.defineProperties({}, Object.getOwnPropertyDescriptors(obj));

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

  • Нельзя указать одновременно value/writable и get/set — TypeError.
  • writable: false защищает только ссылку: если значение — объект, его содержимое можно менять.
  • configurable: false необратим.
  • Изменение флагов writable/configurable у унаследованного readonly-свойства блокирует создание собственного свойства с тем же именем при присваивании.
  • Этот механизм лежит в основе Object.freeze, Object.seal и реактивности Vue 2.

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

  • defineProperty(obj, key, { value, writable, enumerable, configurable }).
  • В defineProperty флаги по умолчанию false.
  • Readonly: writable: false, геттер без сеттера, Object.freeze, приватное поле + геттер.
  • enumerable: false скрывает свойство из перебора и JSON.
  • getOwnPropertyDescriptor(s) — посмотреть флаги.

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

MDN: Object.defineProperty(), learn.javascript.ru: Флаги и дескрипторы свойств.

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

Поиск

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