consistent-return

要求 return 语句始终或从不指定值

与静态类型语言强制函数返回指定类型的值不同，JavaScript 允许函数中不同的代码路径返回不同类型的值。

JavaScript 中令人困惑的一个方面是，如果以下任何一项为真，函数将返回 undefined

在退出之前，它没有执行 return 语句
它执行了 return，但没有显式指定值
它执行了 return undefined
它执行了 return void，后跟一个表达式（例如，函数调用）
它执行了 return，后跟任何其他求值为 undefined 的表达式

如果函数中的任何代码路径显式返回值，但某些代码路径未显式返回值，则可能是类型错误，尤其是在大型函数中。在以下示例中

通过函数的代码路径返回布尔值 true
另一个代码路径未显式返回值，因此隐式返回 undefined

function doSomething(condition) {
    if (condition) {
        return true;
    } else {
        return;
    }
}
1
2
3
4
5
6
7

规则详情

此规则要求 return 语句始终或从不指定值。此规则忽略名称以大写字母开头的函数定义，因为构造函数（当使用 new 运算符调用时）如果未显式返回另一个对象，则会隐式返回实例化的对象。

此规则的错误代码示例

在 Playground 中打开

/*eslint consistent-return: "error"*/

function doSomething(condition) {
    if (condition) {
        return true;
    } else {
        return;
    }
}

function doSomethingElse(condition) {
    if (condition) {
        return true;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

此规则的正确代码示例

在 Playground 中打开

/*eslint consistent-return: "error"*/

function doSomething(condition) {
    if (condition) {
        return true;
    } else {
        return false;
    }
}

function Foo() {
    if (!(this instanceof Foo)) {
        return new Foo();
    }

    this.a = 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

选项

此规则有一个对象选项

"treatUndefinedAsUnspecified": false (默认) 始终指定值或仅隐式返回 undefined。
"treatUndefinedAsUnspecified": true 始终指定值或显式或隐式返回 undefined。

treatUndefinedAsUnspecified

使用默认 { "treatUndefinedAsUnspecified": false } 选项时，此规则的错误代码示例

在 Playground 中打开

/*eslint consistent-return: ["error", { "treatUndefinedAsUnspecified": false }]*/

function foo(callback) {
    if (callback) {
        return void callback();
    }
    // no return statement
}

function bar(condition) {
    if (condition) {
        return undefined;
    }
    // no return statement
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

使用 { "treatUndefinedAsUnspecified": true } 选项时，此规则的错误代码示例

在 Playground 中打开

/*eslint consistent-return: ["error", { "treatUndefinedAsUnspecified": true }]*/

function foo(callback) {
    if (callback) {
        return void callback();
    }
    return true;
}

function bar(condition) {
    if (condition) {
        return undefined;
    }
    return true;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

使用 { "treatUndefinedAsUnspecified": true } 选项时，此规则的正确代码示例

在 Playground 中打开

/*eslint consistent-return: ["error", { "treatUndefinedAsUnspecified": true }]*/

function foo(callback) {
    if (callback) {
        return void callback();
    }
    // no return statement
}

function bar(condition) {
    if (condition) {
        return undefined;
    }
    // no return statement
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

何时不使用它

如果您希望函数根据代码分支具有不同的 return 行为，则禁用此规则是安全的。

版本

此规则在 ESLint v0.4.0 中引入。

资源

编辑此页