← Back to rules

typescript/no-invalid-void-type 限制

它的作用

禁止在返回类型和配置的泛型上下文之外使用 void 类型。

为什么这是个问题？

在 TypeScript 中，void 主要在返回位置具有意义。在其他类型位置（如参数、属性、别名以及大多数联合类型）中使用 void 通常会造成混淆，并且常常表明类型设计存在错误。

示例

此规则的错误代码示例：

function takeVoid(arg: void) {}
type Alias = void;
type Union = string | void;

此规则的正确代码示例：

function f(): void {}
type P = Promise<void>;
type U = void | never;

配置

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

allowAsThisParameter

type: boolean

default: false

是否允许函数的 this 参数为 void。

allowInGenericTypeArguments

type: array | boolean

allowInGenericTypeArguments[n]

type: string

如何使用

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

配置文件 (.oxlintrc.json)

{
  "rules": {
    "typescript/no-invalid-void-type": "error"
  }
}

CLI

oxlint --deny typescript/no-invalid-void-type

参考资料

• 规则源码