noConfusingVoidType

TypeScript and TSX

摘要

¥Summary

规则生效日期：v1.2.0

¥Rule available since: v1.2.0
诊断类别：lint/suspicious/noConfusingVoidType

¥Diagnostic Category: lint/suspicious/noConfusingVoidType
此规则为推荐规则，默认启用。

¥This rule is recommended, which means is enabled by default.
此规则包含 unsafe 修复程序。

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

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

¥Sources:
- 与 @typescript-eslint/no-invalid-void-type 相同
  
  ¥Same as @typescript-eslint/no-invalid-void-type

如何配置

¥How to configure

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

描述

¥Description

禁止在通用或返回类型之外使用 void 类型。

¥Disallow void type outside of generic or return types.

TypeScript 中的 void 指的是一个应该被忽略的函数返回。尝试在返回类型或类型参数之外使用 void 类型通常是程序员错误的标志。即使使用正确，void 也会误导其他开发者。

¥void in TypeScript refers to a function return that is meant to be ignored. Attempting to use a void type outside of a return type or a type parameter is often a sign of programmer error. void can also be misleading for other developers even if used correctly.

void 类型意味着不能与除 never 之外的任何其他类型混合，never 接受所有类型。如果你认为需要这个，那么你可能想要 undefined 类型。

¥The void type means cannot be mixed with any other types, other than never, which accepts all types. If you think you need this then you probably want the undefined type instead.

代码操作建议使用 undefined 而不是 void。这是不安全的，因为 void 类型的变量不能赋值给 undefined 类型的变量。

¥The code action suggests using undefined instead of void. It is unsafe because a variable with the void type cannot be assigned to a variable with the undefined type.

示例

¥Examples

无效

¥Invalid

1
let foo: void;

code-block.ts:1:10 lint/suspicious/noConfusingVoidType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ void is confusing outside a return type or a type parameter.
  
  > 1 │ let foo: void;
      │          ^^^^
    2 │ 
  
  ℹ Unsafe fix: Use undefined instead.
  
    1   │ - let·foo:·void;
      1 │ + let·foo:·undefined;
    2 2 │

1
function logSomething(thing: void) {}

code-block.ts:1:30 lint/suspicious/noConfusingVoidType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ void is confusing outside a return type or a type parameter.
  
  > 1 │ function logSomething(thing: void) {}
      │                              ^^^^
    2 │ 
  
  ℹ Unsafe fix: Use undefined instead.
  
    1   │ - function·logSomething(thing:·void)·{}
      1 │ + function·logSomething(thing:·undefined)·{}
    2 2 │

1
interface Interface {
2
    prop: void;
3
}

code-block.ts:2:11 lint/suspicious/noConfusingVoidType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ void is confusing outside a return type or a type parameter.
  
    1 │ interface Interface {
  > 2 │     prop: void;
      │           ^^^^
    3 │ }
    4 │ 
  
  ℹ Unsafe fix: Use undefined instead.
  
    1 1 │   interface Interface {
    2   │ - ····prop:·void;
      2 │ + ····prop:·undefined;
    3 3 │   }
    4 4 │

1
type PossibleValues = number | void;

code-block.ts:1:32 lint/suspicious/noConfusingVoidType  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ void is confusing inside a union type.
  
  > 1 │ type PossibleValues = number | void;
      │                                ^^^^
    2 │ 
  
  ℹ Unsafe fix: Use undefined instead.
  
    1   │ - type·PossibleValues·=·number·|·void;
      1 │ + type·PossibleValues·=·number·|·undefined;
    2 2 │

有效

¥Valid

1
function foo(): void {};

1
function doSomething(this: void) {}

1
function printArg<T = void>(arg: T) {}

noConfusingVoidType

摘要

如何配置

描述

示例

无效

有效

相关链接