feat(types): Make DepositPreauth easier to guard #2355
Closed
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
`DepositPreauth` transaction is now a union type to correctly model that the `Authorize` and `Unauthorize` fields cannot appear at the same time.
mvadari
reviewed
Jun 28, 2023
| @@ -13,6 +13,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr | |||
| * Add type for NFToken object that is stored on a `NFTokenPage`. | |||
| * Add type for `account_info`'s `account_flags` property. | |||
|
|
|||
| ### Changed | |||
| * `DeposityPreauth` has a new type definition that will not allow `Authorize` and `Unauthorize` on the same instance. This provides better guard support. | |||
There was a problem hiding this comment.
Suggested change
| * `DeposityPreauth` has a new type definition that will not allow `Authorize` and `Unauthorize` on the same instance. This provides better guard support. | |
| * `DepositPreauth` has a new type definition that will not allow `Authorize` and `Unauthorize` on the same instance. This provides better guard support. |
mvadari
reviewed
Jun 28, 2023
Comment on lines
+15
to
+16
| DepositPreauthWithAuthorize, | ||
| DepositPreauthWithUnauthorize, |
There was a problem hiding this comment.
Do these two need to be exported?
There was a problem hiding this comment.
Yes if people want to type guard.
|
This makes the documentation output look goofy. Closing for now. |
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.
High Level Overview of Change
DepositPreauthtransaction is now a union type to correctly model that theAuthorizeandUnauthorizefields cannot appear at the same time.Type of Change