92 lines
1.9 KiB
Markdown
92 lines
1.9 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.
|
|
|
|
-->
|
|
|
|
# propertySymbols
|
|
|
|
> Return an array of an object's own [symbol][@stdlib/symbol/ctor] properties.
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var propertySymbols = require( '@stdlib/utils/property-symbols' );
|
|
```
|
|
|
|
#### propertySymbols( obj )
|
|
|
|
Returns an `array` of an object's own [symbol][@stdlib/symbol/ctor].
|
|
|
|
```javascript
|
|
var symbols = propertySymbols( {} );
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="notes">
|
|
|
|
## Notes
|
|
|
|
- In contrast to the built-in `Object.getOwnPropertySymbols()`, if provided `null` or `undefined`, the function returns an empty `array`, rather than throwing an error.
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var hasSymbolSupport = require( '@stdlib/assert/has-symbol-support' );
|
|
var Symbol = require( '@stdlib/symbol/ctor' );
|
|
var propertySymbols = require( '@stdlib/utils/property-symbols' );
|
|
|
|
function Foo() {
|
|
if ( hasSymbolSupport() ) {
|
|
this[ Symbol( 'beep' ) ] = 'boop';
|
|
}
|
|
return this;
|
|
}
|
|
|
|
Foo.prototype.foo = 'bar';
|
|
|
|
var obj = new Foo();
|
|
var symbols = propertySymbols( obj );
|
|
|
|
console.log( symbols );
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<section class="links">
|
|
|
|
[@stdlib/symbol/ctor]: https://www.npmjs.com/package/@stdlib/symbol-ctor
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|