Skip to content

Commit

Permalink
docs: Describe guard options for guard-for-in (#16986)
Browse files Browse the repository at this point in the history
Describes the different checks that can be used to satisfy
guard-for-in and links prefer-object-has-own as a related rule.
  • Loading branch information
alope107 committed Mar 15, 2023
1 parent 69bc0e2 commit 5251a92
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/src/rules/guard-for-in.md
Expand Up @@ -2,6 +2,7 @@
title: guard-for-in
rule_type: suggestion
related_rules:
- prefer-object-has-own
- no-prototype-builtins
further_reading:
- https://javascriptweblog.wordpress.com/2011/01/04/exploring-javascript-for-in-loops/
Expand All @@ -17,6 +18,10 @@ for (key in foo) {
}
```

For codebases that do not support ES2022, `Object.prototype.hasOwnProperty.call(foo, key)` can be used as a check that the property is not inherited.

For codebases that do support ES2022, `Object.hasOwn(foo, key)` can be used as a shorter alternative; see [prefer-object-has-own](prefer-object-has-own).

Note that simply checking `foo.hasOwnProperty(key)` is likely to cause an error in some cases; see [no-prototype-builtins](no-prototype-builtins).

## Rule Details
Expand Down

0 comments on commit 5251a92

Please sign in to comment.