版本

symbol-description

要求 Symbol 描述

Symbol 函数可能有一个可选的描述

const foo = Symbol("some description");

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

使用 description 可以更轻松地进行调试:当记录一个 symbol 时,会使用描述

const foo = Symbol("some description");

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

当在调试期间观察到 symbol 时,它可以帮助识别 symbol。

规则详情

此规则要求在创建 symbol 时提供描述。

示例

此规则的错误代码示例

在 Playground 中打开
/*eslint symbol-description: "error"*/

const foo = Symbol();

此规则的正确代码示例

在 Playground 中打开
/*eslint symbol-description: "error"*/

const foo = Symbol("some description");

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

何时不使用

此规则不应在 ES3/5 环境中使用。此外,如果您不想在创建 Symbol 时强制要求 description,则可以安全地关闭此规则。

版本

此规则在 ESLint v3.4.0 中引入。

延伸阅读

资源

更改语言