Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/utils-property-symbols
Return an array of an object's own symbol properties.
https://github.com/stdlib-js/utils-property-symbols
javascript node node-js nodejs obj object own properties props stdlib sym symbol symbols util utilities utility utils
Last synced: 5 days ago
JSON representation
Return an array of an object's own symbol properties.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-property-symbols
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-02T00:13:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T01:17:35.000Z (about 1 month ago)
- Last Synced: 2024-10-26T02:31:30.939Z (12 days ago)
- Topics: javascript, node, node-js, nodejs, obj, object, own, properties, props, stdlib, sym, symbol, symbols, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 376 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We 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!
# propertySymbols
[![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 [symbol][@stdlib/symbol/ctor] properties.
## Installation
```bash
npm install @stdlib/utils-property-symbols
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## 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( {} );
```
## 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
```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 );
```
* * *
## See Also
- [`@stdlib/utils-property-names`][@stdlib/utils/property-names]: return an array of an object's own enumerable and non-enumerable property names.
- [`@stdlib/utils-property-symbols-in`][@stdlib/utils/property-symbols-in]: return an array of an object's own and inherited symbol properties.
* * *
## Notice
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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-property-symbols.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-property-symbols
[test-image]: https://github.com/stdlib-js/utils-property-symbols/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-property-symbols/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-property-symbols/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-property-symbols?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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-property-symbols/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-property-symbols/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-property-symbols/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-property-symbols/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-property-symbols/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-property-symbols/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-property-symbols/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-property-symbols/main/LICENSE
[@stdlib/symbol/ctor]: https://github.com/stdlib-js/symbol-ctor
[@stdlib/utils/property-names]: https://github.com/stdlib-js/utils-property-names
[@stdlib/utils/property-symbols-in]: https://github.com/stdlib-js/utils-property-symbols-in