[breaking] Replace optional stripe.elements mode params with discriminated union #756
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
bmathews-stripe
approved these changes
May 7, 2025
dali-stripe
approved these changes
May 7, 2025
alexlande-stripe
changed the title
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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 & motivation
Updates
StripeElementsOptionsModeto use a discriminated union onmodefor better type safety around conditionally required parametersamountandcurrency. See the updated tests for examples!This is a breaking change because these type changes are not backwards compatible, although no behavior has actually changed (the types are just more accurate).
Testing & documentation
Added valid and invalid test cases, and fixed a valid test case that was not actually valid but was caught by this change.