# es/no-symbol-prototype-description

disallow the Symbol.prototype.description property

  • ✅ The following configurations enable this rule: plugin:es/no-new-in-es2019, plugin:es/restrict-to-es3, plugin:es/restrict-to-es5, plugin:es/restrict-to-es2015, plugin:es/restrict-to-es2016, plugin:es/restrict-to-es2017, and plugin:es/restrict-to-es2018

This rule reports ES2019 Symbol.prototype.description property (opens new window) as errors.

This rule is silent by default because it's hard to know types. You need to configure the aggressive mode or TypeScript in order to enable this rule.

# 💡 Examples

⛔ Examples of incorrect code for this rule:

/*eslint es/no-symbol-prototype-description: [error, { aggressive: true }] */ Symbol("foo").description
Now loading...

# 🔧 Options

This rule has an option.

  es/no-symbol-prototype-description: [error, { aggressive: false }]

# aggressive: boolean

Configure the aggressive mode for only this rule. This is prior to the settings.es.aggressive setting.

# 📚 References