1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
|
<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# isAccessorProperty
> Test if an object's own property has an accessor descriptor.
<section class="usage">
## Usage
```javascript
var isAccessorProperty = require( '@stdlib/assert/is-accessor-property' );
```
#### isAccessorProperty( value, property )
Returns a `boolean` indicating if an object's own `property` has an accessor descriptor.
<!-- eslint-disable no-restricted-syntax -->
```javascript
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 = isAccessorProperty( obj, 'foo' );
// returns false
bool = isAccessorProperty( obj, 'beep' );
// returns false
bool = isAccessorProperty( obj, 'accessor' );
// returns true
```
</section>
<!-- /.usage -->
<section class="notes">
## Notes
- Value arguments other than `null` or `undefined` are coerced to `objects`.
```javascript
var bool = isAccessorProperty( 'beep', 'length' );
// returns false
```
- Non-symbol property arguments are coerced to `strings`.
```javascript
var defineProperty = require( '@stdlib/utils/define-property' );
var obj = {};
function getter() {
return true;
}
defineProperty( obj, 'null', {
'configurable': true,
'enumerable': true,
'get': getter
});
var bool = isAccessorProperty( obj, null );
// returns true
```
</section>
<!-- /.notes -->
<section class="examples">
## Examples
<!-- eslint-disable object-curly-newline -->
<!-- eslint no-undef: "error" -->
```javascript
var isAccessorProperty = require( '@stdlib/assert/is-accessor-property' );
var bool = isAccessorProperty( [ 'a' ], 'length' );
// returns false
bool = isAccessorProperty( { 'a': 'b' }, 'a' );
// returns false
bool = isAccessorProperty( [ 'a' ], 0 );
// returns false
bool = isAccessorProperty( { 'null': false }, null );
// returns false
bool = isAccessorProperty( { '[object Object]': false }, {} );
// returns false
bool = isAccessorProperty( {}, 'toString' );
// returns false
bool = isAccessorProperty( {}, 'hasOwnProperty' );
// returns false
bool = isAccessorProperty( null, 'a' );
// returns false
bool = isAccessorProperty( void 0, 'a' );
// returns false
```
</section>
<!-- /.examples -->
<section class="links">
</section>
<!-- /.links -->
|