版本

symbol-description

要求 symbol 描述

`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)

這可能有助於在偵錯期間觀察到符號時識別它們。

規則詳情

此規則要求在建立符號時提供描述。

範例

此規則的**錯誤**程式碼範例

在 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 環境中使用。此外,如果您不想在建立符號時強制要求 `description`,可以安全地關閉此規則。

版本

此規則在 ESLint v3.4.0 中引入。

延伸閱讀

資源

變更語言