fix(types): change any[] to unknown[], if creating a matrix of dy…
#21
Conversation
This file contains hidden or 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
…namic size BREAKING CHANGE
github-actions bot
pushed a commit
that referenced
this pull request
Nov 19, 2023
## [3.0.3](v3.0.2...v3.0.3) (2023-11-19) ### Bug Fixes * **types:** change `any[]` to `unknown[]`, if creating a matrix of dy… ([#21](#21)) ([aaaae72](aaaae72))
|
🎉 This PR is included in version 3.0.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 is a breaking change to how the library handles cases where a primitive instead of a literal type is used for the number of dimensions. Previously, the resulting
Matrixwould resolve toany[], as the complier is unable to infer how it should be typed (other than that it must be an array). This allowed to compiler to avoid throwing atype instantiation is excessively deeperror, but also introduced ananyinto the user's codebase, which is less than ideal.Now, the library will return a type of
unknown[]in these cases. This achieves the same basic amount of type safety, but also means that users will not be able to use the resulting matrix in as many places asany[]would have allowed. The resulting matrix must now be typed by the caller. If you are able to provide more information than the compiler can infer. If not, then an explicit return type ofany[]will provide the most 'relaxed' typing experience.