Skip to content

Commit

Permalink
docs: no-param-reassign mention strict mode (#17494)
Browse files Browse the repository at this point in the history
* no-param-reassign strict mode mention

* Update docs/src/rules/no-param-reassign.md

Fixes #17484 

Co-authored-by: Nitin Kumar <snitin315@gmail.com>

---------

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Nitin Kumar <snitin315@gmail.com>
  • Loading branch information
3 people committed Aug 25, 2023
1 parent 9cd7ac2 commit 7a51d77
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/src/rules/no-param-reassign.md
Expand Up @@ -6,7 +6,7 @@ further_reading:
---


Assignment to variables declared as function parameters can be misleading and lead to confusing behavior, as modifying function parameters will also mutate the `arguments` object. Often, assignment to function parameters is unintended and indicative of a mistake or programmer error.
Assignment to variables declared as function parameters can be misleading and lead to confusing behavior, as modifying function parameters will also mutate the `arguments` object when not in strict mode (see [When Not To Use It](#when-not-to-use-it) below). Often, assignment to function parameters is unintended and indicative of a mistake or programmer error.

This rule can be also configured to fail when function parameters are modified. Side effects on parameters can cause counter-intuitive execution flow and make errors difficult to track down.

Expand Down Expand Up @@ -183,3 +183,5 @@ function foo(barBaz) {
## When Not To Use It

If you want to allow assignment to function parameters, then you can safely disable this rule.

Strict mode code doesn't sync indices of the arguments object with each parameter binding. Therefore, this rule is not necessary to protect against arguments object mutation in ESM modules or other strict mode functions.

0 comments on commit 7a51d77

Please sign in to comment.