Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/nonenumerable-properties/docs/types/index.d"

Index

Functions

Export assignment nonEnumerableProperties

  • nonEnumerableProperties(value: any): Array<string | symbol>
  • Returns an array of an object's own non-enumerable property names and symbols.

    Notes

    • Property order is not guaranteed, as object property enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's properties, thus allowing for deterministic extraction.
    • If provided null or undefined, the function returns an empty array.

    Parameters

    • value: any

      input object

    Returns Array < string | symbol >

    a list of own non-enumerable property names and symbols

    Example

    var defineProperty = require( `@stdlib/utils/define-property` );
    
    var obj = {};
    
    obj.a = 'a';
    defineProperty( obj, 'b', {
        'configurable': false,
        'enumerable': false,
        'writable': false,
        'value': 'b'
    });
    
    var props = nonEnumerableProperties( obj );
    // returns [ 'b' ]