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

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isDataProperty

NPM version Build Status Coverage Status

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

Installation

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

Usage

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

isDataProperty( value, property )

Returns a boolean indicating if a value has a data 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, 'accessor', {
    'configurable': false,
    'enumerable': false,
    'get': function getter() {
        return obj.foo;
    },
    'set': function setter( v ) {
        obj.foo = v;
    }
});

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

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

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

Notes

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

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

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

Examples

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

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

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

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

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

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

bool = isDataProperty( {}, 'toString' );
// returns false

bool = isDataProperty( {}, 'hasOwnProperty' );
// returns false

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

bool = isDataProperty( 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-2024. The Stdlib Authors.

Package Sidebar

Install

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

Homepage

stdlib.io

Weekly Downloads

9

Version

0.2.1

License

Apache-2.0

Unpacked Size

28.5 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser