time-to-botec/squiggle/node_modules/@stdlib/utils/writable-property-names/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.5 KiB

writablePropertyNames

Return an array of an object's own writable property names.

Usage

var writablePropertyNames = require( '@stdlib/utils/writable-property-names' );

writablePropertyNames( obj )

Returns an array of an object's own writable property names.

var defineProperty = require( '@stdlib/utils/define-property' );

var obj = {
    'a': 'b'
};

defineProperty( obj, 'c', {
    'configurable': true,
    'enumerable': true,
    'writable': false,
    'value': 'd'
});

var keys = writablePropertyNames( obj );
// returns [ 'a' ]

Notes

  • Name order is not guaranteed, as object key enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's keys, thus allowing for deterministic extraction.

Examples

var defineProperty = require( '@stdlib/utils/define-property' );
var writablePropertyNames = require( '@stdlib/utils/writable-property-names' );

function Foo() {
    this.a = {
        'b': 'c'
    };
    defineProperty( this, 'baz', {
        'configurable': true,
        'enumerable': true,
        'writable': false,
        'value': 'qux'
    });
    return this;
}

Foo.prototype.foo = [ 'bar' ];
defineProperty( Foo.prototype, 'bip', {
    'configurable': false,
    'enumerable': false,
    'writable': false,
    'value': 'bop'
});

var obj = new Foo();
var keys = writablePropertyNames( obj );

console.log( keys );
// => [ 'a' ]