优先使用返回 this 类型

强制在仅返回 this 类型时使用 this。

🔒

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

🔧

此规则报告的一些问题可以通过 --fix ESLint 命令行选项自动修复。

💭

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

方法链是 OOP 语言中的一种常见模式，TypeScript 提供了一种特殊的多态 this 类型来简化它。显式声明类名而不是 this 的返回类型的类方法，使得扩展类调用该方法变得更加困难：返回的对象将被类型化为基类，而不是派生类。

此规则报告当类方法声明类名而不是 this 的返回类型时。

class Animal {
  eat(): Animal {
    //   ~~~~~~
    // Either removing this type annotation or replacing
    // it with `this` would remove the type error below.
    console.log("I'm moving!");
    return this;
  }
}

class Cat extends Animal {
  meow(): Cat {
    console.log('Meow~');
    return this;
  }
}

const cat = new Cat();
cat.eat().meow();
//        ~~~~
// Error: Property 'meow' does not exist on type 'Animal'.
// because `eat` returns `Animal` and not all animals meow.

.eslintrc.cjs
module.exports = {
  "rules": {
    "@typescript-eslint/prefer-return-this-type": "error"
  }
};

在游乐场中尝试此规则 ↗

示例

❌ 不正确
✅ 正确

class Foo {
  f1(): Foo {
    return this;
  }
  f2 = (): Foo => {
    return this;
  };
  f3(): Foo | undefined {
    return Math.random() > 0.5 ? this : undefined;
  }
}
在游乐场中打开

class Foo {
  f1(): this {
    return this;
  }
  f2() {
    return this;
  }
  f3 = (): this => {
    return this;
  };
  f4 = () => {
    return this;
  };
}

class Base {}
class Derived extends Base {
  f(): Base {
    return this;
  }
}
在游乐场中打开

选项

此规则不可配置。

何时不使用它

如果您不使用方法链或显式返回值，您可以安全地关闭此规则。

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

示例​

选项​

何时不使用它​

资源​

示例

选项

何时不使用它

资源