← Back to rules

typescript/no-restricted-types 限制

An auto-fix is available for this rule.

它的作用

禁止使用某些类型。

为什么这是个问题？

一些内置类型有别名，而某些类型被认为具有危险性或有害性。通常禁用某些类型有助于保持一致性与安全性。

示例

给定配置 { "types": { "Foo": { "message": "使用 Bar 代替", "fixWith": "Bar" } } }：

此规则的错误代码示例：

let value: Foo;

此规则的正确代码示例：

let value: Bar;

此规则的其他配置选项示例：

• 仅显示消息，不提供修复或建议，禁用 Foo 类型： { "types": { "Foo": "请使用 OtherType 代替。" } }

• 禁用 Bar 类型并提供建议： { "types": { "Bar": { "message": "避免使用 Bar。", "suggest": "BazQux" } } }

• 使用通用消息禁用 Object 类型： { "types": { "Object": true } }

配置

此规则接受一个包含以下属性的配置对象：

types

type: object

默认值: {}

类型名称到禁止配置的映射。

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "rules": {
    "typescript/no-restricted-types": "error"
  }
}

CLI

oxlint --deny typescript/no-restricted-types

参考资料

• 规则源码