Описание символов

Требуются описания символов

Функция Symbol может иметь необязательное описание:

var foo = Symbol("some description");

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

Использование description способствует более лёгкой отладке: при регистрации символа используется описание:

var foo = Symbol("some description");

> console.log(foo);
// Symbol(some description)

Это может облегчить идентификацию символов при наблюдении за ними во время отладки.

Подробности правила

Это правило требует описания при создании символов.

Примеры

Примеры некорректного кода для этого правила:

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

var foo = Symbol();

Примеры корректного кода для этого правила:

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

var foo = Symbol("some description");

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

Когда не следует его использовать

Это правило не должно использоваться в средах ES3/5. Кроме того, это правило можно безопасно отключить, если вы не хотите навязывать наличие description при создании символов.

Версия

Это правило было введено в ESLint v3.4.0.

Дополнительные материалы

Ресурсы

• Исходный код правила
• Тесты