Skip to content

es-x/no-symbol-prototype-description ​

disallow the Symbol.prototype.description property

This rule reports ES2019 Symbol.prototype.description property 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:

🔧 Options ​

This rule has an option.

jsonc
{
  "rules": {
    "es-x/no-symbol-prototype-description": [
      "error",
      {
        "aggressive": false,
        "allowTestedProperty": false
      }
    ]
  }
}

aggressive: boolean ​

Configure the aggressive mode for only this rule. This is prior to the settings['es-x'].aggressive setting.

allowTestedProperty: boolean ​

Configure the allowTestedProperty mode for only this rule. This is prior to the settings['es-x'].allowTestedProperty setting.

🚀 Version ​

This rule was introduced in eslint-plugin-es v5.0.0.

📚 References ​