main.js (1673B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var propertyDescriptorIn = require( '@stdlib/utils/property-descriptor-in' ); 24 25 26 // MAIN // 27 28 /** 29 * Tests if an object's own or inherited property is enumerable. 30 * 31 * @param {*} value - value to test 32 * @param {*} property - property to test 33 * @returns {boolean} boolean indicating if an object property is enumerable 34 * 35 * @example 36 * var defineProperty = require( '@stdlib/utils/define-property' ); 37 * 38 * var obj = { 39 * 'boop': true 40 * }; 41 * 42 * defineProperty( obj, 'beep', { 43 * 'configurable': true, 44 * 'enumerable': false, 45 * 'writable': true, 46 * 'value': true 47 * }); 48 * 49 * var bool = isEnumerablePropertyIn( obj, 'boop' ); 50 * // returns true 51 * 52 * bool = isEnumerablePropertyIn( obj, 'beep' ); 53 * // returns false 54 */ 55 function isEnumerablePropertyIn( value, property ) { 56 var desc = propertyDescriptorIn( value, property ); // Note: works for both property names and symbols, which the `in` operator does not. 57 return ( desc !== null && desc.enumerable === true ); 58 } 59 60 61 // EXPORTS // 62 63 module.exports = isEnumerablePropertyIn;