Feature: add full response typing for status code, data and headers. #272
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
This commit adds additional type information to the route's response object that allows types to be created that express the combination of status code, data and headers for each response. This type information can be used to "narrow" a response type based on an HTTP status code. This narrowing is useful since it can prevent type mismatches where a status code is presumed to have one type but in actuality it returns another. Additionally, response headers are now associated with data types and status codes rather than being free form. A caveat right now is that only there are no response codes like 3XX or 5XX, every code must be explicitly listed.
Merged
js2me
added a commit
that referenced
this pull request
Jul 14, 2021
* added --unwrap-response-data to unwrap the data item from the response (#268) * added --unwrap-response-data to unwrap the data item from the response * add axios --unwrap-response-data Co-authored-by: Christian Zangl <[email protected]> * fix: formdata in axios template (#277) Co-authored-by: Tiago Kaneta <[email protected]> * Feature: add full response typing for status code, data and headers. (#272) This commit adds additional type information to the route's response object that allows types to be created that express the combination of status code, data and headers for each response. This type information can be used to "narrow" a response type based on an HTTP status code. This narrowing is useful since it can prevent type mismatches where a status code is presumed to have one type but in actuality it returns another. Additionally, response headers are now associated with data types and status codes rather than being free form. A caveat right now is that only there are no response codes like 3XX or 5XX, every code must be explicitly listed. * bump: up version to 9.2.0 Co-authored-by: Christian Zangl <[email protected]> Co-authored-by: Christian Zangl <[email protected]> Co-authored-by: Tiago Surjus Kaneta <[email protected]> Co-authored-by: Tiago Kaneta <[email protected]> Co-authored-by: Rusty Conover <[email protected]>
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.
This commit adds additional type information to the route's response
object that allows types to be created that express the combination
of status code, data and headers for each response.
This type information can be used to "narrow" a response type based on
an HTTP status code. This narrowing is useful since it can prevent type
mismatches where a status code is presumed to have one type but in actuality
it returns another.
Additionally, response headers are now associated with data types and status
codes rather than being free form.
A caveat right now is that only there are no response codes like 3XX or
5XX, every code must be explicitly listed.