guard-for-in

要求 for-in 循环包含 if 语句

使用 for in 循环遍历对象将包含通过原型链继承的属性。这种行为可能导致循环中出现意外的项目。

for (key in foo) {
    doSomething(key);
}
1
2
3

对于不支持 ES2022 的代码库，可以使用 Object.prototype.hasOwnProperty.call(foo, key) 作为检查属性是否未被继承的方法。

对于支持 ES2022 的代码库，可以使用 Object.hasOwn(foo, key) 作为更短的替代方案；请参阅 prefer-object-has-own。

请注意，简单地检查 foo.hasOwnProperty(key) 很可能在某些情况下导致错误；请参阅 no-prototype-builtins。

规则详情

此规则旨在防止在 for in 循环中不筛选结果的情况下使用 for in 循环可能引起的意外行为。因此，当 for in 循环未使用 if 语句筛选其结果时，它会发出警告。

此规则的错误代码示例

/*eslint guard-for-in: "error"*/

for (key in foo) {
    doSomething(key);
}
1
2
3
4
5

此规则的正确代码示例

/*eslint guard-for-in: "error"*/

for (key in foo) {
    if (Object.hasOwn(foo, key)) {
        doSomething(key);
    }
}

for (key in foo) {
    if (Object.prototype.hasOwnProperty.call(foo, key)) {
        doSomething(key);
    }
}

for (key in foo) {
    if ({}.hasOwnProperty.call(foo, key)) {
        doSomething(key);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

相关规则

• prefer-object-has-own
• no-prototype-builtins

版本

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

延伸阅读

探索 JavaScript for-in 循环
javascriptweblog.wordpress.com

在 JavaScript 中使用对象作为映射的陷阱
2ality.com

资源

• 规则来源
• 测试来源