useIterableCallbackReturn

JavaScript (and super languages)

摘要

¥Summary

规则生效日期：v2.0.0

¥Rule available since: v2.0.0
诊断类别：lint/suspicious/useIterableCallbackReturn

¥Diagnostic Category: lint/suspicious/useIterableCallbackReturn
此规则为推荐规则，默认启用。

¥This rule is recommended, which means is enabled by default.
此规则没有修复方案。

¥This rule doesn’t have a fix.
此规则的默认严重级别为 error。

¥The default severity of this rule is error.
来源：

¥Sources:
- 与 array-callback-return 相同
  
  ¥Same as array-callback-return

如何配置

¥How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "useIterableCallbackReturn": "error"
6
      }
7
    }
8
  }
9
}

描述

¥Description

强制可迭代回调函数返回值保持一致。

¥Enforce consistent return values in iterable callbacks.

此规则确保传递给某些可迭代方法的回调函数始终返回一个值或从不返回一个值，具体取决于方法的要求。

¥This rule ensures that callbacks passed to certain iterable methods either always return a value or never return a value, depending on the method’s requirements.

请注意，异步回调和生成器回调会被忽略，因为它们分别始终返回 Promise 或 Generator。

¥Note that async and generator callbacks are ignored as they always return Promise or Generator respectively.

方法及其要求

¥Methods and Their Requirements

以下方法的回调函数需要返回值：

¥The following methods require a return in their callback:

every
filter
find
findIndex
findLast
findLastIndex
flatMap
map
reduce
reduceRight
some
sort
toSorted — from（在 Array 上调用时）

¥toSorted — from (when called on Array)

方法 forEach 不允许返回值。

¥A return value is disallowed in the method forEach.

示例

¥Examples

无效

¥Invalid

1
[].map(() => {
2
    // Missing return value
3
});

code-block.js:1:4 lint/suspicious/useIterableCallbackReturn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This callback passed to map() iterable method should always return a value.
  
  > 1 │ [].map(() => {
      │    ^^^
    2 │     // Missing return value
    3 │ });
  
  ℹ Add a return with a value to this callback.

1
[].forEach(() => {
2
    return 1; // Should not return a value
3
});

code-block.js:1:4 lint/suspicious/useIterableCallbackReturn ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ This callback passed to forEach() iterable method should not return a value.
  
  > 1 │ [].forEach(() => {
      │    ^^^^^^^
    2 │     return 1; // Should not return a value
    3 │ });
  
  ℹ Either remove this return or remove the returned value.
  
  > 1 │ [].forEach(() => {
      │                   
  > 2 │     return 1; // Should not return a value
      │     ^^^^^^^
    3 │ });
    4 │

有效

¥Valid

1
[].map(() => {
2
    return 1; // Correctly returns a value
3
});

1
[].forEach(() => {
2
    // No return value, which is correct
3
});

1
[].forEach(() => void null); // Void return value, which doesn't trigger the rule

useIterableCallbackReturn

摘要

如何配置

描述

方法及其要求

示例

无效

有效

相关链接