@stdlib/assert-is-accessor-property-in

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!

isAccessorPropertyIn

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

Installation

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

Usage

var isAccessorPropertyIn = require( '@stdlib/assert-is-accessor-property-in' );

isAccessorPropertyIn( value, property )

Returns a boolean indicating if an object's own or inherited property has an accessor descriptor.

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 = isAccessorPropertyIn( obj, 'foo' );
// returns false

bool = isAccessorPropertyIn( obj, 'beep' );
// returns false

bool = isAccessorPropertyIn( obj, 'accessor' );
// returns true

Notes

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

  var bool = isAccessorPropertyIn( 'beep', 'length' );
  // returns false

• Non-symbol property arguments are coerced to strings.

  var defineProperty = require( '@stdlib/utils-define-property' );
  
  var obj = {};
  
  function getter() {
      return true;
  }
  
  defineProperty( obj, 'null', {
      'configurable': true,
      'enumerable': true,
      'get': getter
  });
  
  var bool = isAccessorPropertyIn( obj, null );
  // returns true

Examples

var isAccessorPropertyIn = require( '@stdlib/assert-is-accessor-property-in' );

var bool = isAccessorPropertyIn( [ 'a' ], 'length' );
// returns false

bool = isAccessorPropertyIn( { 'a': 'b' }, 'a' );
// returns false

bool = isAccessorPropertyIn( [ 'a' ], 0 );
// returns false

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

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

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

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

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

bool = isAccessorPropertyIn( void 0, 'a' );
// returns false

---

See Also

• @stdlib/assert-has-property: test if an object has a specified property, either own or inherited.
• @stdlib/assert-is-accessor-property: test if an object's own property has an accessor descriptor.
• @stdlib/assert-is-data-property-in: test if an object's own or inherited property has a data descriptor.

---

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.