Change spec types to allow ReadonlyArray choices#112
Merged
Conversation
Owner
|
Looks good to me, thanks! |
tuannm151
pushed a commit
to BSSCommerce/shopify-envalid
that referenced
this pull request
Jul 1, 2024
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
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.
In TypeScript, the current type definitions don't allow the following:
Given that the
choicesfield doesn't need to be modified (only theincludemethod is used currently), it should be allowed to be aReadonlyArray. Generally in TS, it’s good practice to useReadonlyArrayoverArraywhen no mutation is intended.Any
Array<T>is also assignable toReadonlyArray<T>, so this change doesn't break any existing behaviour.This change uses
ReadonlyArray<T>instead ofreadonly T[]to maintain compatibility with TS <3.x.