Package Exports

@stdlib/utils-writable-properties

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-writable-properties) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

writableProperties

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

Installation

npm install @stdlib/utils-writable-properties

Usage

var writableProperties = require( '@stdlib/utils-writable-properties' );

writableProperties( obj )

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

var obj = {
    'a': 1,
    'b': 2
};

var props = writableProperties( obj );
// e.g., returns [ 'a', 'b' ]

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.

Examples

var defineProperty = require( '@stdlib/utils-define-property' );
var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
var Symbol = require( '@stdlib/symbol-ctor' );
var writableProperties = require( '@stdlib/utils-writable-properties' );

var hasSymbols = hasSymbolSupport();
var props;
var obj;

function Foo() {
    this.a = 'a';
    defineProperty( this, 'b', {
        'configurable': true,
        'enumerable': true,
        'writable': false,
        'value': 'b'
    });
    if ( hasSymbols ) {
        this[ Symbol( 'a' ) ] = 'a';
        defineProperty( this, Symbol( 'b' ), {
            'configurable': true,
            'enumerable': true,
            'writable': false,
            'value': 'b'
        });
    }
    return this;
}

Foo.prototype.c = 'c';
if ( hasSymbols ) {
    Foo.prototype[ Symbol( 'c' ) ] = 'c';
}

obj = new Foo();
props = writableProperties( obj );

console.log( props );
// e.g., => [ 'a', ... ]

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/utils-writable-properties