Needlessly Postulating Minds

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

    0.0.6 • Public • Published

    writablePropertySymbolsIn

    NPM version Build Status Coverage Status dependencies

    Return an array of an object's own and inherited writable symbol properties.

    Installation

    npm install @stdlib/utils-writable-property-symbols-in

    Usage

    var writablePropertySymbolsIn = require( '@stdlib/utils-writable-property-symbols-in' );

    writablePropertySymbolsIn( obj )

    Returns an array of an object's own and inherited writable symbol properties.

    var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
    var Symbol = require( '@stdlib/symbol-ctor' );
    var defineProperty = require( '@stdlib/utils-define-property' );
    
    var obj = {};
    
    if ( hasSymbolSupport() ) {
        defineProperty( obj, Symbol( 'a' ), {
            'configurable': false,
            'enumerable': false,
            'writable': true,
            'value': 'b'
        });
    }
    
    var symbols = writablePropertySymbolsIn( obj );

    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 writablePropertySymbolsIn = require( '@stdlib/utils-writable-property-symbols-in' );
    
    var hasSymbols = hasSymbolSupport();
    var symbols;
    var obj;
    
    function Foo() {
        if ( hasSymbols ) {
            defineProperty( this, Symbol( 'baz' ), {
                'configurable': false,
                'enumerable': false,
                'writable': true,
                'value': 'qux'
            });
        }
        return this;
    }
    
    if ( hasSymbols ) {
        defineProperty( Foo.prototype, Symbol( 'bip' ), {
            'configurable': false,
            'enumerable': false,
            'writable': true,
            'value': 'bop'
        });
    }
    
    obj = new Foo();
    symbols = writablePropertySymbolsIn( obj );
    
    console.log( symbols );

    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


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-writable-property-symbols-in

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    7

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    37.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser