Nature's Particle Manager

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

    0.0.7 • Public • Published

    isWritableProperty

    NPM version Build Status Coverage Status

    Test if an object's own property is writable.

    Installation

    npm install @stdlib/assert-is-writable-property

    Usage

    var isWritableProperty = require( '@stdlib/assert-is-writable-property' );

    isWritableProperty( value, property )

    Returns a boolean indicating if a value has a writable property.

    var defineProperty = require( '@stdlib/utils-define-property' );
    
    var obj = {
        'foo': 'bar'
    };
    
    defineProperty( obj, 'beep', {
        'configurable': false,
        'enumerable': false,
        'writable': false,
        'value': 'boop'
    });
    
    defineProperty( obj, 'setter', {
        'configurable': false,
        'enumerable': false,
        'set': function setter( v ) {
            obj.foo = v;
        }
    });
    
    var bool = isWritableProperty( obj, 'foo' );
    // returns true
    
    bool = isWritableProperty( obj, 'setter' );
    // returns true
    
    bool = isWritableProperty( obj, 'beep' );
    // returns false

    Notes

    • Value arguments other than null or undefined are coerced to objects.

      var bool = isWritableProperty( 'beep', 'length' );
      // returns false
    • Property arguments are coerced to strings.

      var obj = {
          'null': 'foo'
      };
      
      var bool = isWritableProperty( obj, null );
      // returns true

    Examples

    var isWritableProperty = require( '@stdlib/assert-is-writable-property' );
    
    var bool = isWritableProperty( [ 'a' ], 'length' );
    // returns true
    
    bool = isWritableProperty( { 'a': 'b' }, 'a' );
    // returns true
    
    bool = isWritableProperty( [ 'a' ], 0 );
    // returns true
    
    bool = isWritableProperty( { 'null': false }, null );
    // returns true
    
    bool = isWritableProperty( { '[object Object]': false }, {} );
    // returns true
    
    bool = isWritableProperty( {}, 'toString' );
    // returns false
    
    bool = isWritableProperty( {}, 'hasOwnProperty' );
    // returns false
    
    bool = isWritableProperty( null, 'a' );
    // returns false
    
    bool = isWritableProperty( void 0, 'a' );
    // returns false

    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


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-writable-property

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    374

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    39.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser