版本

getter-return

在 getter 中强制使用 return 语句

推荐

配置文件 中使用来自 @eslint/jsrecommended 配置将启用此规则

get 语法将对象属性绑定到一个函数,当查找该属性时将调用该函数。它首次引入于 ECMAScript 5。

var p = {
    get name(){
        return "nicholas";
    }
};

Object.defineProperty(p, "age", {
    get: function (){
        return 17;
    }
});

请注意,每个 getter 都应该返回一个值。

规则详情

此规则强制在属性 getter 中存在 return 语句。

此规则的错误代码示例

在游乐场中打开
/*eslint getter-return: "error"*/

p = {
    get name(){
        // no returns.
    }
};

Object.defineProperty(p, "age", {
    get: function (){
        // no returns.
    }
});

class P{
    get name(){
        // no returns.
    }
}

此规则的正确代码示例

在游乐场中打开
/*eslint getter-return: "error"*/

p = {
    get name(){
        return "nicholas";
    }
};

Object.defineProperty(p, "age", {
    get: function (){
        return 18;
    }
});

class P{
    get name(){
        return "nicholas";
    }
}

选项

此规则有一个对象选项

  • "allowImplicit": false(默认)不允许使用 return 语句隐式返回 undefined

{ "allowImplicit": true } 选项的正确代码示例

在游乐场中打开
/*eslint getter-return: ["error", { allowImplicit: true }]*/
p = {
    get name(){
        return; // return undefined implicitly.
    }
};

何时不使用它

如果您的项目不使用 ES5 属性 getter,则不需要此规则。

由 TypeScript 处理

在使用 TypeScript 时禁用此规则是安全的,因为 TypeScript 的编译器会强制执行此检查。

版本

此规则在 ESLint v4.2.0 中引入。

进一步阅读

资源

更改语言