← Back to rules

eslint/getter-return Nursery

它做了什么

要求所有 getter 都必须包含一个 return 语句。

为什么这是不好的？

getter 应该始终返回一个值。如果没有返回值，很可能是一个错误。

此规则不会在 TypeScript 文件上运行，因为类型检查会捕获那些未返回值的 getter。

示例

此规则的错误代码示例：

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

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

此规则的正确代码示例：

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

配置

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

allowImplicit

type: boolean

默认值: false

当设置为 true 时，允许使用不带表达式的 return 语句隐式返回 undefined。

如何使用

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

配置文件 (.oxlintrc.json)

{
  "rules": {
    "getter-return": "error"
  }
}

CLI

oxlint --deny getter-return

参考资料

• 规则源码