symbol-description

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

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

const foo = Symbol("some description");

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

Использование description упрощает отладку: при выводе символа в журнал используется его описание:

const foo = Symbol("some description");

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

Это может помочь определить символ, обнаруженный во время отладки.

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

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

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

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

const foo = Symbol();

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

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

const foo = Symbol("some description");

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

Параметры

У этого правила нет параметров.

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

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

Версия

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

Дополнительная литература

Ресурсы

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