Nimble Porridge Muncher

    @stdlib/utils-inherited-writable-properties
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    inheritedWritableProperties

    NPM version Build Status Coverage Status

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

    Installation

    npm install @stdlib/utils-inherited-writable-properties

    Usage

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

    inheritedWritableProperties( obj[, level] )

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

    var defineProperty = require( '@stdlib/utils-define-property' );
    
    function Foo() {
        this.a = 'b';
        return this;
    }
    
    defineProperty( Foo.prototype, 'beep', {
        'configurable': false,
        'enumerable': false,
        'writable': true,
        'value': 'boop'
    });
    
    var f = new Foo();
    var props = inheritedWritableProperties( f );
    // e.g., returns [ 'beep', ... ]

    By default, the function walks an object's entire prototype chain. To limit the inheritance level, provide a level argument.

    var defineProperty = require( '@stdlib/utils-define-property' );
    var inherit = require( '@stdlib/utils-inherit' );
    
    function Bar() {
        return this;
    }
    
    defineProperty( Bar.prototype, 'boop', {
        'configurable': false,
        'enumerable': false,
        'writable': true,
        'value': 'beep'
    });
    
    function Foo() {
        Bar.call( this );
        this.a = 'b';
        return this;
    }
    
    inherit( Foo, Bar );
    
    defineProperty( Foo.prototype, 'beep', {
        'configurable': false,
        'enumerable': false,
        'writable': true,
        'value': 'boop'
    });
    
    var f = new Foo();
    var pros = inheritedWritableProperties( f, 1 );
    // e.g., returns [ 'beep', ... ]

    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 hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
    var Symbol = require( '@stdlib/symbol-ctor' );
    var defineProperty = require( '@stdlib/utils-define-property' );
    var inheritedWritableProperties = require( '@stdlib/utils-inherited-writable-properties' );
    
    var hasSymbols = hasSymbolSupport();
    var props;
    var obj;
    
    function Foo() {
        this.beep = 'boop';
        this.a = {
            'b': 'c'
        };
        defineProperty( this, 'baz', {
            'configurable': false,
            'enumerable': false,
            'writable': true,
            'value': 'qux'
        });
        if ( hasSymbols ) {
            this[ Symbol( 'a' ) ] = 'b';
            defineProperty( this, 'beep', {
                'configurable': false,
                'enumerable': false,
                'writable': false,
                'value': 'boop'
            });
        }
        return this;
    }
    
    Foo.prototype.c = 'd';
    defineProperty( Foo.prototype, 'bip', {
        'configurable': false,
        'enumerable': false,
        'writable': false,
        'value': 'bop'
    });
    if ( hasSymbols ) {
        Foo.prototype[ Symbol( 'c' ) ] = 'd';
        defineProperty( Foo.prototype, Symbol( 'e' ), {
            'configurable': false,
            'enumerable': false,
            'writable': false,
            'value': 'f'
        });
    }
    
    obj = new Foo();
    props = inheritedWritableProperties( obj );
    
    console.log( props );
    // e.g., => [ 'c', ... ]

    See Also


    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

    Chat


    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/utils-inherited-writable-properties

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    35

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    43.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser