137 lines
2.8 KiB
Markdown
137 lines
2.8 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# inheritedPropertyDescriptors
|
||
|
|
|
||
|
|
> Return an object's inherited [property descriptors][@stdlib/utils/property-descriptors].
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
<!-- eslint-disable id-length -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var inheritedPropertyDescriptors = require( '@stdlib/utils/inherited-property-descriptors' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### inheritedPropertyDescriptors( obj\[, level] )
|
||
|
|
|
||
|
|
Returns an object's inherited [property descriptors][@stdlib/utils/property-descriptors].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
function Foo() {
|
||
|
|
this.a = 'b';
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
Foo.prototype.beep = 'boop';
|
||
|
|
|
||
|
|
var f = new Foo();
|
||
|
|
var desc = inheritedPropertyDescriptors( f );
|
||
|
|
// returns { 'beep': {...}, ... }
|
||
|
|
```
|
||
|
|
|
||
|
|
By default, the function walks an object's entire prototype chain. To limit the inheritance level, provide a `level` argument.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var inherit = require( '@stdlib/utils/inherit' );
|
||
|
|
|
||
|
|
function Bar() {
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
Bar.prototype.boop = 'beep';
|
||
|
|
|
||
|
|
function Foo() {
|
||
|
|
Bar.call( this );
|
||
|
|
this.a = 'b';
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
inherit( Foo, Bar );
|
||
|
|
Foo.prototype.beep = 'boop';
|
||
|
|
|
||
|
|
var f = new Foo();
|
||
|
|
var desc = inheritedPropertyDescriptors( f, 1 );
|
||
|
|
// returns { 'beep': {...}, ... }
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="notes">
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- In contrast to the built-in `Object.getOwnPropertyDescriptors()`, if provided `null` or `undefined`, the function returns an empty `object`, rather than throwing an error.
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.notes -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint-disable id-length -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var defineProperty = require( '@stdlib/utils/define-property' );
|
||
|
|
var inheritedPropertyDescriptors = require( '@stdlib/utils/inherited-property-descriptors' );
|
||
|
|
|
||
|
|
function Foo() {
|
||
|
|
this.beep = 'boop';
|
||
|
|
this.a = {
|
||
|
|
'b': 'c'
|
||
|
|
};
|
||
|
|
defineProperty( this, 'baz', {
|
||
|
|
'value': 'qux',
|
||
|
|
'configurable': true,
|
||
|
|
'writable': true,
|
||
|
|
'enumerable': false
|
||
|
|
});
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
Foo.prototype.foo = [ 'bar' ];
|
||
|
|
|
||
|
|
var obj = new Foo();
|
||
|
|
var desc = inheritedPropertyDescriptors( obj );
|
||
|
|
|
||
|
|
console.log( desc );
|
||
|
|
// => { 'foo': {...}, ... }
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[@stdlib/utils/property-descriptors]: https://www.npmjs.com/package/@stdlib/utils/tree/main/property-descriptors
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|