Document type helpers for oneOfs #1023
Merged
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
Add a section to the documentation that shows some TypeScript types that could be useful in working with union-style oneOfs.
|
Looks great, thanks @bhollis ! |
|
🎉 This PR is included in version 1.171.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
stephenh
pushed a commit
that referenced
this pull request
Apr 19, 2024
ref: #1023 In previous helper, it is not possible to construct a message with the oneof field passed as a function argument. This helper allows for strict type checking and construct message using oneof fields as an argument. Example ```proto syntax = "proto3"; package logs; message SignUp { string name = 1; } message Login { string account_id = 1; } message Logout { string account_id = 1; string reason = 2; } message LogPayload { string created_at = 1; oneof payload { SignUp signup = 2; Login login = 3; Logout lougout = 4; } } ``` ```typesecript // pass by argument foo<P extends PaloadNames>( payload: OneOfValue<LogPayload['payload'], P> ) { const req: LogPayload = { createdAt: new Date().toUTCString(), payload, }; send(req); } ``` ```typescript // Usage // Good this.foo( { $case: 'login', login: { accountId: 'accountId', }, }); // Build Fail because case and field is not matched // Argument of type '{ $case: string; login: { accountId: string; }; }' is not assignable to parameter of type 'never'. this.foo( { $case: 'logout', login: { accountId: 'accountId', }, }); ``` Signed-off-by: clucle <wjdenwls123@gmail.com>
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.
Add a section to the documentation that shows some TypeScript types that could be useful in working with union-style oneOfs. I've written these a few times in different projects so I could properly type helper functions that operate on generated oneOfs, and I figured it might be useful to other users of ts-proto.
As an example, given the following:
Then the helpers can be used like this: