Improve errors for read-only array mutations #63
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nolanlawson
reviewed
Jul 22, 2021
nolanlawson
requested changes
Jul 22, 2021
divmain
force-pushed
the
dale/readonly-array-errors-W-7262124
branch
2 times, most recently
from
8d6d95d
to
ee66383
Compare
pmdartus
approved these changes
Jul 23, 2021
kevinv11n
suggested changes
Jul 23, 2021
divmain
force-pushed
the
dale/readonly-array-errors-W-7262124
branch
from
ee66383
to
7d17e6c
Compare
kevinv11n
approved these changes
Jul 23, 2021
abdulsattar
approved these changes
Jul 26, 2021
nolanlawson
approved these changes
Jul 26, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the unhelpful error message discussed in salesforce/lwc#1739, when an attempt is made at mutating a read-only array. Some discussion seems to have occurred offline that wasn't captured in the issue, so the preferred solution wasn't readily apparent. Pinging @apapko @pmdartus @caridy since they previously weighed in.
Before, if someone attempted to mutate a read-only array (using the LWC
@apidecorator, for example), they would be presented with the following error:The error now reads:
The change addresses the specific concern that was raised but may be insufficient to address larger, related DX concerns. Still, this seemed a reasonable resolution and submitting a PR seemed the easiest to facilitate discussion. Happy to go in a different direction if that is preferred.