# Symbol
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
> Symbol namespace.
## Installation
```bash
npm install @stdlib/symbol
```
## Usage
```javascript
var ns = require( '@stdlib/symbol' );
```
#### ns
Symbol namespace.
```javascript
var o = ns;
// returns {...}
```
The namespace contains the following:
- [`AsyncIteratorSymbol`][@stdlib/symbol/async-iterator]: async iterator symbol which specifies the default async iterator for an object.
- [`Symbol( [description] )`][@stdlib/symbol/ctor]: symbol factory.
- [`IteratorSymbol`][@stdlib/symbol/iterator]: iterator symbol which specifies the default iterator for an object.
## Examples
```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/symbol' );
console.log( objectKeys( ns ) );
```
* * *
## 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-2021. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/symbol.svg
[npm-url]: https://npmjs.org/package/@stdlib/symbol
[test-image]: https://github.com/stdlib-js/symbol/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/symbol/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/symbol/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/symbol?branch=main
[dependencies-image]: https://img.shields.io/david/stdlib-js/symbol.svg
[dependencies-url]: https://david-dm.org/stdlib-js/symbol/main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/symbol/main/LICENSE
[@stdlib/symbol/async-iterator]: https://www.npmjs.com/package/@stdlib/symbol/tree/main/async-iterator
[@stdlib/symbol/ctor]: https://www.npmjs.com/package/@stdlib/symbol/tree/main/ctor
[@stdlib/symbol/iterator]: https://www.npmjs.com/package/@stdlib/symbol/tree/main/iterator