no-setter-return

禁止从 setter 返回值

Recommended

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

Setter 不能返回值。

¥Setters cannot return values.

虽然从 setter 返回值不会产生错误,但返回的值将被忽略。因此,从 setter 返回一个值要么是不必要的,要么是可能的错误,因为返回的值不能被使用。

¥While returning a value from a setter does not produce an error, the returned value is being ignored. Therefore, returning a value from a setter is either unnecessary or a possible error, since the returned value cannot be used.

规则详情

¥Rule Details

此规则不允许从 setter 中返回值,并在 setter 函数中报告 return 语句。

¥This rule disallows returning values from setters and reports return statements in setter functions.

只允许没有值的 return,因为它是一个控制流语句。

¥Only return without a value is allowed, as it’s a control flow statement.

此规则检查设置器:

¥This rule checks setters in:

  • 对象字面量。

    ¥Object literals.

  • 类声明和类表达式。

    ¥Class declarations and class expressions.

  • 全局对象的 Object.createObject.definePropertyObject.definePropertiesReflect.defineProperty 方法中的属性描述符。

    ¥Property descriptors in Object.create, Object.defineProperty, Object.defineProperties, and Reflect.defineProperty methods of the global objects.

此规则的错误代码示例:

¥Examples of incorrect code for this rule:

在线运行
/*eslint no-setter-return: "error"*/

var foo = {
    set a(value) {
        this.val = value;
        return value;
    }
};

class Foo {
    set a(value) {
        this.val = value * 2;
        return this.val;
    }
}

const Bar = class {
    static set a(value) {
        if (value < 0) {
            this.val = 0;
            return 0;
        }
        this.val = value;
    }
};

Object.defineProperty(foo, "bar", {
    set(value) {
        if (value < 0) {
            return false;
        }
        this.val = value;
    }
});

此规则的正确代码示例:

¥Examples of correct code for this rule:

在线运行
/*eslint no-setter-return: "error"*/

var foo = {
    set a(value) {
        this.val = value;
    }
};

class Foo {
    set a(value) {
        this.val = value * 2;
    }
}

const Bar = class {
    static set a(value) {
        if (value < 0) {
            this.val = 0;
            return;
        }
        this.val = value;
    }
};

Object.defineProperty(foo, "bar", {
    set(value) {
        if (value < 0) {
            throw new Error("Negative value.");
        }
        this.val = value;
    }
});

由 TypeScript 处理

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

版本

此规则是在 ESLint v6.7.0 中引入。

进阶读物

资源

ESLint 中文网
粤ICP备13048890号