noRestrictedTypes

TypeScript and TSX

摘要

¥Summary

规则生效日期：v1.9.0

¥Rule available since: v1.9.0
诊断类别：lint/style/noRestrictedTypes

¥Diagnostic Category: lint/style/noRestrictedTypes
此规则包含 safe 修复程序。

¥This rule has a safe fix.
此规则的默认严重级别为 warning。

¥The default severity of this rule is warning.
来源：

¥Sources:
- 与 @typescript-eslint/no-restricted-types 相同
  
  ¥Same as @typescript-eslint/no-restricted-types

如何配置

¥How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noRestrictedTypes": "error"
6
      }
7
    }
8
  }
9
}

描述

¥Description

禁止用户定义的类型。

¥Disallow user defined types.

此规则允许你指定不想在应用中使用的类型名称。

¥This rule allows you to specify type names that you don’t want to use in your application.

为防止使用常见的误导类型，你可以参考 noBannedTypes

¥To prevent use of commonly misleading types, you can refer to noBannedTypes

选项

¥Options

使用选项指定要在源代码中限制的其他类型。

¥Use the options to specify additional types that you want to restrict in your source code.

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noRestrictedTypes": {
6
          "options": {
7
            "types": {
8
              "Foo": {
9
                "message": "Only bar is allowed",
10
                "use": "bar"
11
              },
12
              "OldAPI": "Use NewAPI instead"
13
            }
14
          }
15
        }
16
      }
17
    }
18
  }
19
}

在上面的例子中，如果使用 Foo 或 OldAPI，规则将发出诊断信息。

¥In the example above, the rule will emit a diagnostics if Foo or OldAPI are used.

noRestrictedTypes

摘要

如何配置

描述

选项

相关链接