Made array arguments readonly.
#78
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
The array arguments have no business being mutable.
|
I don't know how I could add tests for this. The change affects only the typing. It has no runtime impact. A test of this would have to involve running the compiler on invalid code and see if it gives the correct error. Probably outside the scope of this project. |
|
Indeed, the test I had in mind was a happy-path scenario (calling the methods with a readonly array) and would simply prevent accidental changes to the interface. |
|
This has now been published in the latest version,1.5.0. Thanks for your contribution, it is really appreciated, @geon ! |
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.
The array arguments have no business being mutable.
Purpose
The assertion functions can't be called with ReadonlyArray. That is bad.
Approach
Make the arguments
readonly.Learnings
https://www.typescriptlang.org/docs/handbook/interfaces.html#readonly-properties