Skip to content

eslint/symbol-description Pedantic

What it does

Require symbol descriptions.

Why is this bad?

The Symbol function may have an optional description.

js
var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);

Using description promotes easier debugging: when a symbol is logged the description is used:

js
var foo = Symbol("some description");

console.log(foo);
// prints - Symbol(some description)

Example

javascript
var foo = Symbol();

References

Released under the MIT License.