Return an array of an object's own enumerable symbol properties.
npm install @stdlib/utils-enumerable-property-symbolsWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return an array of an object's own enumerable symbol properties.
``bash`
npm install @stdlib/utils-enumerable-property-symbols
`javascript`
var enumerablePropertySymbols = require( '@stdlib/utils-enumerable-property-symbols' );
#### enumerablePropertySymbols( obj )
Returns an array of an object's own enumerable symbol properties.
`javascript
var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
var Symbol = require( '@stdlib/symbol-ctor' );
var defineProperty = require( '@stdlib/utils-define-property' );
var obj = {};
if ( hasSymbolSupport() ) {
defineProperty( obj, Symbol( 'a' ), {
'configurable': false,
'enumerable': true,
'writable': true,
'value': 'b'
});
}
var symbols = enumerablePropertySymbols( obj );
`
- Property order is not guaranteed, as object property enumeration is not specified according to the [ECMAScript specification][ecma-262-for-in]. In practice, however, most engines use insertion order to sort an object's properties, thus allowing for deterministic extraction.
`javascript
var defineProperty = require( '@stdlib/utils-define-property' );
var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
var Symbol = require( '@stdlib/symbol-ctor' );
var enumerablePropertySymbols = require( '@stdlib/utils-enumerable-property-symbols' );
var hasSymbols = hasSymbolSupport();
var symbols;
var obj;
function Foo() {
if ( hasSymbols ) {
defineProperty( this, Symbol( 'baz' ), {
'configurable': false,
'enumerable': true,
'writable': true,
'value': 'qux'
});
}
return this;
}
if ( hasSymbols ) {
defineProperty( Foo.prototype, Symbol( 'bip' ), {
'configurable': false,
'enumerable': true,
'writable': false,
'value': 'bop'
});
}
obj = new Foo();
symbols = enumerablePropertySymbols( obj );
console.log( symbols );
`
*
- [@stdlib/utils-enumerable-property-symbols-in][@stdlib/utils/enumerable-property-symbols-in]: return an array of an object's own and inherited enumerable symbol properties.
- [@stdlib/utils-inherited-enumerable-property-symbols][@stdlib/utils/inherited-enumerable-property-symbols]: return an array of an object's inherited enumerable symbol properties.
- [@stdlib/utils-keys][@stdlib/utils/keys]: return an array of an object's own enumerable property names.
- [@stdlib/utils-nonenumerable-property-symbols][@stdlib/utils/nonenumerable-property-symbols]: return an array of an object's own non-enumerable symbol properties.
- [@stdlib/utils-property-symbols][@stdlib/utils/property-symbols]: return an array of an object's own symbol properties.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-enumerable-property-symbols.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-enumerable-property-symbols
[test-image]: https://github.com/stdlib-js/utils-enumerable-property-symbols/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/utils-enumerable-property-symbols/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-enumerable-property-symbols/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-enumerable-property-symbols?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-enumerable-property-symbols/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-enumerable-property-symbols/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-enumerable-property-symbols/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-enumerable-property-symbols/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-enumerable-property-symbols/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-enumerable-property-symbols/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-enumerable-property-symbols/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-enumerable-property-symbols/main/LICENSE
[ecma-262-for-in]: https://262.ecma-international.org/5.1/#sec-12.6.4
[@stdlib/utils/enumerable-property-symbols-in]: https://www.npmjs.com/package/@stdlib/utils-enumerable-property-symbols-in
[@stdlib/utils/inherited-enumerable-property-symbols]: https://www.npmjs.com/package/@stdlib/utils-inherited-enumerable-property-symbols
[@stdlib/utils/keys]: https://www.npmjs.com/package/@stdlib/utils-keys
[@stdlib/utils/nonenumerable-property-symbols]: https://www.npmjs.com/package/@stdlib/utils-nonenumerable-property-symbols
[@stdlib/utils/property-symbols]: https://www.npmjs.com/package/@stdlib/utils-property-symbols