Package Exports

@stdlib/utils-property-symbols

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-property-symbols) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

propertySymbols

Return an array of an object's own symbol properties.

Installation

npm install @stdlib/utils-property-symbols

Usage

var propertySymbols = require( '@stdlib/utils-property-symbols' );

propertySymbols( obj )

Returns an array of an object's own symbol.

var symbols = propertySymbols( {} );

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.

Examples

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 );

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.

License

See LICENSE.

@stdlib/utils-property-symbols