Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/utils-writable-property-symbols

Return an array of an object's own writable symbol properties.
https://github.com/stdlib-js/utils-writable-property-symbols

javascript node node-js nodejs obj object own properties props stdlib sym symbols util utilities utility utils writable write

Last synced: 3 months ago
JSON representation

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

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!



# writablePropertySymbols



[![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 writable symbol properties.



## Installation



```bash

npm install @stdlib/utils-writable-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 writablePropertySymbols = require( '@stdlib/utils-writable-property-symbols' );

```



#### writablePropertySymbols( obj )



Returns an `array` of an object's own writable 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': false,

        'writable': true,

        'value': 'b'

    });

}



var symbols = writablePropertySymbols( obj );

```



## Notes



-   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.



## Examples



```javascript

var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );

var Symbol = require( '@stdlib/symbol-ctor' );

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



var hasSymbols = hasSymbolSupport();



function Foo() {

    if ( hasSymbols ) {

        this[ Symbol( 'baz' ) ] = 'qux';

    }

    return this;

}



if ( hasSymbols ) {

    Foo.prototype[ Symbol( 'bip' ) ] = 'bop';

}



var obj = new Foo();

var symbols = writablePropertySymbols( obj );

// e.g., returns [ Symbol( 'baz' ) ]

```



* * *



## See Also



-   [`@stdlib/utils-inherited-writable-property-symbols`][@stdlib/utils/inherited-writable-property-symbols]: return an array of an object's inherited writable symbol properties.

-   [`@stdlib/utils-writable-properties`][@stdlib/utils/writable-properties]: return an array of an object's own writable property names and symbols.

-   [`@stdlib/utils-writable-property-names`][@stdlib/utils/writable-property-names]: return an array of an object's own writable property names.

-   [`@stdlib/utils-writable-property-symbols-in`][@stdlib/utils/writable-property-symbols-in]: return an array of an object's own and inherited writable symbol properties.

-   [`@stdlib/utils-property-symbols`][@stdlib/utils/property-symbols]: return an array of an object's own 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-writable-property-symbols.svg

[npm-url]: https://npmjs.org/package/@stdlib/utils-writable-property-symbols



[test-image]: https://github.com/stdlib-js/utils-writable-property-symbols/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/utils-writable-property-symbols/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-writable-property-symbols/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/utils-writable-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-writable-property-symbols/tree/deno

[deno-readme]: https://github.com/stdlib-js/utils-writable-property-symbols/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/utils-writable-property-symbols/tree/umd

[umd-readme]: https://github.com/stdlib-js/utils-writable-property-symbols/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/utils-writable-property-symbols/tree/esm

[esm-readme]: https://github.com/stdlib-js/utils-writable-property-symbols/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/utils-writable-property-symbols/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-writable-property-symbols/main/LICENSE



[ecma-262-for-in]: https://262.ecma-international.org/5.1/#sec-12.6.4



[@stdlib/utils/inherited-writable-property-symbols]: https://github.com/stdlib-js/utils-inherited-writable-property-symbols



[@stdlib/utils/writable-properties]: https://github.com/stdlib-js/utils-writable-properties



[@stdlib/utils/writable-property-names]: https://github.com/stdlib-js/utils-writable-property-names



[@stdlib/utils/writable-property-symbols-in]: https://github.com/stdlib-js/utils-writable-property-symbols-in



[@stdlib/utils/property-symbols]: https://github.com/stdlib-js/utils-property-symbols