Object.prototype.__defineGetter__()

Метод __defineGetter__() экземпляров Object связывает свойство объекта с функцией, которая будет вызвана при обращении к этому свойству.

Синтаксис

__defineGetter__(prop, func)

Параметры

prop

Строка, содержащая имя свойства, с которым связан геттер func.

func

Функция, которая будет связана с обращением к указанному свойству.

Возвращаемое значение

Ничего (undefined).

Исключения

TypeError

Выбрасывается, если func не является функцией.

Описание

Все объекты, которые наследуются от Object.prototype (то есть все, кроме объектов без прототипа null), наследуют метод __defineGetter__(). Этот метод позволяет определить геттер для уже существующего объекта. Это эквивалентно Object.defineProperty(obj, prop, { get: func, configurable: true, enumerable: true }), что означает, что свойство является перечисляемым и конфигурируемым, и любой существующий сеттер, если он есть, сохраняется.

__defineGetter__() определен в спецификации как «нормативный необязательный» (normative optional), что означает, что его реализация не требуется. Однако все основные браузеры реализуют его, и благодаря его продолжающемуся использованию его удаление маловероятно. Если браузер реализует __defineGetter__(), ему также необходимо реализовать методы __lookupGetter__(), __lookupSetter__() и __defineSetter__().

Примеры

Использование __defineGetter__()

const o = {};
o.__defineGetter__("gimmeFive", function () {
  return 5;
});
console.log(o.gimmeFive); // 5

Определение свойства геттера стандартными способами

Вы можете использовать синтаксис get для определения геттера при первой инициализации объекта.

const o = {
  get gimmeFive() {
    return 5;
  },
};
console.log(o.gimmeFive); // 5

Вы также можете использовать Object.defineProperty() для определения геттера в объекте после его создания. По сравнению с __defineGetter__(), этот метод позволяет вам контролировать перечисляемость и конфигурируемость геттера, а также определять свойства символов. Метод Object.defineProperty() также работает с объектами без прототипа null, которые не наследуют от Object.prototype и, следовательно, не имеют метода __defineGetter__().

const o = {};
Object.defineProperty(o, "gimmeFive", {
  get() {
    return 5;
  },
  configurable: true,
  enumerable: true,
});
console.log(o.gimmeFive); // 5

Спецификации

Совместимость с браузерами

Смотрите также

• Полифилл Object.prototype.__defineGetter__ в core-js
• Object.prototype.__defineSetter__()
• get
• Object.defineProperty()
• Object.prototype.__lookupGetter__()
• Object.prototype.__lookupSetter__()
• Руководство JS: Определение геттеров и сеттеров
• Баг Firefox 647423