feat(schemas)!: improve TypeScript definitions for array values#26172
Merged
feat(schemas)!: improve TypeScript definitions for array values#26172
Conversation
Make the minItems explicit in our TypeScript types.
github-actions
bot
added
schema
caugner
added
the
semver-major-bump
Contributor
Author
|
@queengooborg @Elchi3 I'll bring this up tomorrow, but if you peek before, feel free to let me know what you think about this change. Basically, this restricts our array types. |
caugner
added
the
meeting agenda
Contributor
Author
|
@ddbeck We quickly discussed this on Tuesday, and there were no concerns. What do you think about this change? |
Contributor
Author
|
As discussed in today's BCD meeting, there's general consensus in favor of this change. For a future release, we consider moving to an array-only build output, making it easier to consume the data. |
Elchi3
approved these changes
Mar 25, 2025
caugner
changed the title
Merged
Contributor
|
Ack. Unfortunately, this is already causing some issues in the collector project. One example:
|
caugner
removed
the
meeting agenda
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
3 participants
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.
Summary
Refines our TypeScript array types to account for
minItems.E.g.
string | [string, string, ...string[]]guarantees that if the value is an array, then the first two values arestring, rather thanstring | undefined.Important
This is a breaking change.
Test results and supporting details
Related issues