禁止不安全的返回值

禁止从函数返回类型为 any 的值。

✅

在 "plugin:@typescript-eslint/recommended-type-checked" 中扩展 ESLint 配置将启用此规则。

💭

此规则需要类型信息才能运行。

TypeScript 中的 any 类型是类型系统中危险的“逃生舱”。使用 any 会禁用许多类型检查规则，通常最好仅在万不得已时或在对代码进行原型设计时使用。

尽管您有最好的意图，但 any 类型有时会泄漏到您的代码库中。从函数返回 any 类型的 value 会在您的代码库中创建一个潜在的类型安全漏洞和错误来源。

此规则禁止从函数返回 any 或 any[]。

此规则还比较泛型类型参数类型，以确保您不会在泛型位置返回不安全的 any 到期望特定类型的函数。例如，如果您从声明为返回 Set<string> 的函数返回 Set<any>，它将报错。

.eslintrc.cjs
module.exports = {
  "rules": {
    "@typescript-eslint/no-unsafe-return": "error"
  }
};

在游乐场中尝试此规则 ↗

示例

❌ 不正确
✅ 正确

function foo1() {
  return 1 as any;
}
function foo2() {
  return Object.create(null);
}
const foo3 = () => {
  return 1 as any;
};
const foo4 = () => Object.create(null);

function foo5() {
  return [] as any[];
}
function foo6() {
  return [] as Array<any>;
}
function foo7() {
  return [] as readonly any[];
}
function foo8() {
  return [] as Readonly<any[]>;
}
const foo9 = () => {
  return [] as any[];
};
const foo10 = () => [] as any[];

const foo11 = (): string[] => [1, 2, 3] as any[];

// generic position examples
function assignability1(): Set<string> {
  return new Set<any>([1]);
}
type TAssign = () => Set<string>;
const assignability2: TAssign = () => new Set<any>([true]);
在游乐场中打开

function foo1() {
  return 1;
}
function foo2() {
  return Object.create(null) as Record<string, unknown>;
}

const foo3 = () => [];
const foo4 = () => ['a'];

function assignability1(): Set<string> {
  return new Set<string>(['foo']);
}
type TAssign = () => Set<string>;
const assignability2: TAssign = () => new Set(['foo']);
在游乐场中打开

在某些情况下，该规则允许将 any 返回到 unknown。

允许的 any 到 unknown 返回的示例

function foo1(): unknown {
  return JSON.parse(singleObjString); // Return type for JSON.parse is any.
}

function foo2(): unknown[] {
  return [] as any[];
}
在游乐场中打开

选项

此规则不可配置。

何时不使用它

如果您的代码库中有许多现有的 any 或不安全代码区域，则可能难以启用此规则。在提高项目中不安全区域的类型安全之前，跳过 no-unsafe-* 规则可能更容易。您可以考虑使用 ESLint 禁用注释来处理这些特定情况，而不是完全禁用此规则。

类型检查的 lint 规则比传统的 lint 规则更强大，但也需要配置类型检查的 lint。如果您在启用类型检查规则后遇到性能下降，请参阅性能故障排除。

示例​

选项​

何时不使用它​

相关​

资源​

示例

选项

何时不使用它

相关

资源