symbol-description

Require symbol descriptions

The Symbol function may have an optional description:

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);
1
2
3
4

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

var foo = Symbol("some description");

> console.log(foo);
// Symbol(some description)
1
2
3
4

It may facilitate identifying symbols when one is observed during debugging.

Rule Details

This rules requires a description when creating symbols.

Examples

Examples of incorrect code for this rule:

Open in Playground

/*eslint symbol-description: "error"*/

var foo = Symbol();
1
2
3

Examples of correct code for this rule:

Open in Playground

/*eslint symbol-description: "error"*/

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);
1
2
3
4
5
6

When Not To Use It

This rule should not be used in ES3/5 environments. In addition, this rule can be safely turned off if you don’t want to enforce presence of description when creating Symbols.

Version

This rule was introduced in ESLint v3.4.0.

Resources

Edit this page