Skip to content

docs(eslint-plugin): [prefer-readonly-parameter-types] mention limitations #9260

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

Merged
merged 2 commits into from
Jun 5, 2024
Merged

docs(eslint-plugin): [prefer-readonly-parameter-types] mention limitations #9260

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8818cee
docs(eslint-plugin): [prefer-readonly-parameter-types] mention limita…
JoshuaKGoldberg Jun 4, 2024
886c716
as readonly
JoshuaKGoldberg Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/eslint-plugin/docs/rules/prefer-readonly-parameter-types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,3 +402,8 @@ function foo(arg: MyType) {}
## When Not To Use It

If your project does not attempt to enforce strong immutability guarantees of parameters, you can avoid this rule.

This rule is very strict on what it considers mutable.
Many types that describe themselves as readonly are considered mutable because they have mutable properties such as arrays or tuples.
To work around these limitations, you might need to use the rule's options.
In particular, the [`allow` option](#allow) can explicitly mark a type as readonly.