Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: no-param-reassign mention strict mode #17494

Merged
merged 3 commits into from
Aug 25, 2023
Merged

docs: no-param-reassign mention strict mode #17494

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a986f3
no-param-reassign strict mode mention
stephen-hardy Aug 23, 2023
473d1e0
Merge pull request #1 from stephen-hardy/stephen-hardy-patch-1
stephen-hardy Aug 23, 2023
6d50c70
Update docs/src/rules/no-param-reassign.md
nzakas Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/src/rules/no-param-reassign.md
View file
Open in desktop
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.