# symbol-description

> Returns description of provided symbol

Latest version **1.1.0** (published 2019-10-05) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install symbol-description
pnpm add symbol-description
yarn add symbol-description
bun add symbol-description
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-10-05 |
| First published | 2016-11-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Shahar Or |
| Maintainers | mightyiam |
| Keywords | description, symbol, string |

## Links

- npm: https://www.npmjs.com/package/symbol-description
- Repository: https://github.com/mightyiam/symbol-description
- Homepage: https://github.com/mightyiam/symbol-description#readme
- Issues: https://github.com/mightyiam/symbol-description/issues
- npm.io page: https://npm.io/package/symbol-description

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2019-10-05
- 1.0.0 — 2016-11-30

## README

# symbol-description [![Build Status](https://travis-ci.org/mightyiam/symbol-description.svg?branch=master)](https://travis-ci.org/mightyiam/symbol-description)

Returns description of provided symbol.

```js
import { symbolDescription } from 'symbol-description'

symbolDescription(Symbol()) // undefined
symbolDescription(Symbol('foo')) // 'foo'
symbolDescription(Symbol.for('foo')) // 'foo'
symbolDescription(Symbol.for()) // 'undefined' (string)
```

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

---
_Source: https://npm.io/package/symbol-description · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._