Skip to content
← Back to rules

eslint/getter-return Correctness

This rule is turned on by default.

作用

要求所有 getter 都有一个 return 语句。

为什么不好?

Getter 应该始终返回一个值。如果没有,那可能是一个错误。

此规则不在 TypeScript 文件上运行,因为类型检查会 捕获没有返回值的 getter。

示例

此规则 错误 代码的示例:

javascript
class Person {
  get name() {
    // 没有 return
  }
}

const obj = {
  get foo() {
    // 对象 getter 也会被检查
  },
};

此规则 正确 代码的示例:

javascript
class Person {
  get name() {
    return this._name;
  }
}

配置

此规则接受一个具有以下属性的配置对象:

allowImplicit

type: boolean

default: false

当设置为 true 时,允许 getter 通过包含无表达式的 return 语句隐式返回 undefined

使用方法

To enable this rule using the config file or in the CLI, you can use:

json
{
  "rules": {
    "getter-return": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "getter-return": "error",
  },
});
bash
oxlint --deny getter-return

版本

此规则是在 v0.0.3 中添加的。

参考资料