assert-is-data-property-in

Test if an object's own or inherited property has a data descriptor.

APACHE-2.0 License

Downloads
37
Stars
2
Committers
1

isDataPropertyIn

Test if an object's own or inherited property has a data descriptor.

Installation

npm install @stdlib/assert-is-data-property-in

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var isDataPropertyIn = require( '@stdlib/assert-is-data-property-in' );

isDataPropertyIn( value, property )

Returns a boolean indicating if a value has a data property (either own or inherited).

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

var bool;
var obj;

function Foo() {
    this.foo = 'bar';
    return this;
}

defineProperty( Foo.prototype, 'beep', {
    'configurable': false,
    'enumerable': false,
    'writable': false,
    'value': 'boop'
});

defineProperty( Foo.prototype, 'accessor', {
    'configurable': false,
    'enumerable': false,
    'get': function getter() {
        return obj.foo;
    },
    'set': function setter( v ) {
        obj.foo = v;
    }
});

obj = new Foo();

bool = isDataPropertyIn( obj, 'foo' );
// returns true

bool = isDataPropertyIn( obj, 'beep' );
// returns true

bool = isDataPropertyIn( obj, 'accessor' );
// returns false

Notes

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

    var bool = isDataPropertyIn( 'beep', 'length' );
    // returns true
    
  • Non-symbol property arguments are coerced to strings.

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

Examples

var isDataPropertyIn = require( '@stdlib/assert-is-data-property-in' );

var bool = isDataPropertyIn( [ 'a' ], 'length' );
// returns true

bool = isDataPropertyIn( { 'a': 'b' }, 'a' );
// returns true

bool = isDataPropertyIn( [ 'a' ], 0 );
// returns true

bool = isDataPropertyIn( { 'null': false }, null );
// returns true

bool = isDataPropertyIn( { '[object Object]': false }, {} );
// returns true

bool = isDataPropertyIn( {}, 'toString' );
// returns true

bool = isDataPropertyIn( {}, 'hasOwnProperty' );
// returns true

bool = isDataPropertyIn( null, 'a' );
// returns false

bool = isDataPropertyIn( 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


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.