array-callback-return

在数组方法的回调中强制执行 return 语句

Array 有几种过滤、映射和折叠的方法。如果我们忘记在这些回调中写 return 语句，那可能是一个错误。如果您不想使用 return 或不需要返回的结果，请考虑使用 .forEach 代替。

// example: convert ['a', 'b', 'c'] --> {a: 0, b: 1, c: 2}
var indexMap = myArray.reduce(function(memo, item, index) {
  memo[item] = index;
}, {}); // Error: cannot set property 'b' of undefined

规则详情

此规则强制在数组方法的回调中使用 return 语句。此外，它还可以通过使用 checkForEach 选项强制 forEach 数组方法回调不返回值。

此规则查找以下方法的回调函数，然后检查 return 语句的使用情况。

• Array.from
• Array.prototype.every
• Array.prototype.filter
• Array.prototype.find
• Array.prototype.findIndex
• Array.prototype.findLast
• Array.prototype.findLastIndex
• Array.prototype.flatMap
• Array.prototype.forEach（可选，基于 checkForEach 参数）
• Array.prototype.map
• Array.prototype.reduce
• Array.prototype.reduceRight
• Array.prototype.some
• Array.prototype.sort
• 及以上类型的数组。

此规则的错误代码示例：

/*eslint array-callback-return: "error"*/

var indexMap = myArray.reduce(function(memo, item, index) {
    memo[item] = index;
}, {});

var foo = Array.from(nodes, function(node) {
    if (node.tagName === "DIV") {
        return true;
    }
});

var bar = foo.filter(function(x) {
    if (x) {
        return true;
    } else {
        return;
    }
});

此规则的正确代码示例：

/*eslint array-callback-return: "error"*/

var indexMap = myArray.reduce(function(memo, item, index) {
    memo[item] = index;
    return memo;
}, {});

var foo = Array.from(nodes, function(node) {
    if (node.tagName === "DIV") {
        return true;
    }
    return false;
});

var bar = foo.map(node => node.getAttribute("id"));

选项

此规则接受具有两个选项的配置对象：

• "allowImplicit": false（默认）当设置为 true 时，允许需要返回值的方法的回调隐式返回 undefined，其中 return 语句不包含表达式。
• "checkForEach": false（默认）当设置为 true 时，规则还会报告返回值的 forEach 回调。

allowImplicit

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

/*eslint array-callback-return: ["error", { allowImplicit: true }]*/
var undefAllTheThings = myArray.map(function(item) {
    return;
});

checkForEach

{ "checkForEach": true } 选项的错误代码示例：

/*eslint array-callback-return: ["error", { checkForEach: true }]*/

myArray.forEach(function(item) {
    return handleItem(item)
});

myArray.forEach(function(item) {
    if (item < 0) {
        return x;
    }
    handleItem(item);
});

myArray.forEach(item => handleItem(item));

myArray.forEach(item => {
    return handleItem(item);
});

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

/*eslint array-callback-return: ["error", { checkForEach: true }]*/

myArray.forEach(function(item) {
    handleItem(item)
});

myArray.forEach(function(item) {
    if (item < 0) {
        return;
    }
    handleItem(item);
});

myArray.forEach(function(item) {
    handleItem(item);
    return;
});

myArray.forEach(item => {
    handleItem(item);
});

已知限制

此规则检查具有给定名称的方法的回调函数，即使具有该方法的对象不是数组。

何时不使用

如果您不想在数组方法的回调中警告使用 return 语句，那么禁用此规则是安全的。