JavaScript метод Object.prototype.propertyIsEnumerable()

Определение и применение

JavaScript метод propertyIsEnumerable() возвращает логическое значение, которое определяет является ли указанное свойство или метод целевого объекта перечислимым. Метод не учитывает свойства унаследованные из цепочки прототипов.

Метод propertyIsEnumerable() возвращает значение true, если свойство или метод существует в объекте и является перечислимым, в обратном случае возвращает значение false (если объект не имеет свойства или метода с указанным именем, или если указанное свойство или метод не является перечислимым).

Под перечислимыми свойствами стоит понимать те, атрибут enumerable которых имеет значение true, для строковых ключей это означает, что они будут перечислимы в циклах, например в цикле for...in. Атрибуты в свою очередь описываются дескрипторами свойств – это обычные объекты JavaScript, которые описывают атрибуты и значение свойства. Подробную информацию о дескрипторах свойств и атрибутах вы можете получить в описании метода defineProperty(), который позволяет определить новое или изменить существующее свойство объекта, описывая его дескрипторами.

Проверяется собственное свойство со строковым или символьным ключом. Пользовательские свойства не всегда перечислимы: у свойств, созданных через defineProperty(), и у методов класса enumerable по умолчанию равен false.

Поддержка браузерами

Спецификация: ecma262

Поддерживается во всех основных браузерах с 2015 года.

Показать браузеры
Совместимостьjavascript.builtins.Object.propertyIsEnumerable
ВозможностьКомпьютерыМобильные
ChromeEdgeFirefoxOperaSafariChrome AndroidFirefox for AndroidOpera AndroidSafari on iOSSamsung BrowserWebView AndroidWebView on iOS
propertyIsEnumerable✓1✓12✓1✓4✓3✓18✓4✓10.1✓1✓1.0✓1✓1

поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31

JavaScript синтаксис

JavaScript
obj.propertyIsEnumerable( property );

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

ECMAScript: Object.prototype.propertyIsEnumerable()

Значения параметров

Object: справочные сведения
Параметр Описание
property Строковый или символьный ключ проверяемого свойства. Обязательное значение.

Примеры, попробуйте сами

В примере «Изменение перечислимости свойства» показан результат вызова метода.

Изменение перечислимости свойства

Измените свойства исходного объекта и сравните результат до и после вызова метода.

index.html
HTML
<!doctype html>
<html lang="ru">
  <head>
    <meta charset="UTF-8" />
    <title>Изменение перечислимости свойства</title>
  </head>
  <body>
    <p>Результат выполнения выводится в консоль.</p>
  </body>
</html>
main.js
JavaScript
let obj = {
    // инициализируем переменную, содержащую объект
    a: 1,
    b: 2,
    c() {
        return this.a + this.b
    },
}
// определяем является ли указанное свойство или метод целевого объекта перечислимым
console.log(obj.propertyIsEnumerable('a')) // true
console.log(obj.propertyIsEnumerable('b')) // true
console.log(obj.propertyIsEnumerable('c')) // true
console.log(obj.propertyIsEnumerable('d')) // false (элемент не существует)
// выводим в цикле все перечисляемые свойства и методы
for (let key in obj) {
    console.log(key)
}
// a
// b
// c
// изменяем в объекте существующее свойство, описывая его дескриптором
Object.defineProperty(obj, 'c', {
    enumerable: false,
})
// определяем является ли указанное свойство или метод целевого объекта перечислимым
console.log(obj.propertyIsEnumerable('a')) // true
console.log(obj.propertyIsEnumerable('b')) // true
console.log(obj.propertyIsEnumerable('c')) // false
// выводим в цикле все перечисляемые свойства и методы
for (let key in obj) {
    console.log(key)
}
// a
// b

В этом примере мы инициализировали переменную, содержащую объект. С помощью метода propertyIsEnumerable() мы определяем являются ли указанные свойства или методы целевого объекта перечислимыми. Свойства этого литерала объекта являются перечислимыми. После этого мы выводим в консоль, используя цикл все перечисляемые свойства и методы.

С использованием метода defineProperty() мы изменили существующее свойство объекта, описывая его дескриптором в котором указали, что метод объекта "c" неперечислим.

После этого мы снова с помощью метода propertyIsEnumerable() определяем являются ли указанные свойства или методы целевого объекта перечислимыми. Как вы можете заметить свойство "c" в этом случае не перечислимо и оно не будет выведено в консоль в цикле.

В следующем примере мы используем метод propertyIsEnumerable() на массиве:

В примере «Индексы и длина массива» показан результат вызова метода.

Индексы и длина массива

Измените свойства исходного объекта и сравните результат до и после вызова метода.

index.html
HTML
<!doctype html>
<html lang="ru">
  <head>
    <meta charset="UTF-8" />
    <title>Индексы и длина массива</title>
  </head>
  <body>
    <p>Результат выполнения выводится в консоль.</p>
  </body>
</html>
main.js
JavaScript
let arr = ['a', 'b', 'c'] // инициализируем переменную, содержащую массив

// определяем является ли указанный элемент перечислимым

console.log(arr.propertyIsEnumerable(0)) // true
console.log(arr.propertyIsEnumerable(1)) // true
console.log(arr.propertyIsEnumerable(2)) // true
console.log(arr.propertyIsEnumerable(3)) // false (элемент не существует)

console.log(arr.length) // 3

console.log(arr.propertyIsEnumerable('length')) // false