This repository was archived by the owner on Oct 25, 2023. It is now read-only.
always specify return-type of api-calls #5
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
this enhances compatibility with language-servers, especially it allowa the JetBrains language server to correctly resolve the return-type
MaZderMind
commented
Jun 30, 2022
templates/default/procedure-call.eta
Outdated
| switch(config.httpClientType) { | ||
| case HTTP_CLIENT.AXIOS: { | ||
| return `Promise<AxiosResponse<${type}>>` | ||
| } | ||
| default: { | ||
| return `Promise<HttpResponse<${type}, ${errorType}>` | ||
| return `Promise<HttpResponse<${type}, ${errorType}>>` |
There was a problem hiding this comment.
I have no Idea how that worked in the past 😬
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
currently, the response-type of the data-attribute of the response of an api-call has to be deduced by following the lambda to the parametrized request function and evaluating it return type. This confuses the JetBrains (ie. IntelliJ / WebStorm) language server and it can't deduce the return-type of an await or then-statement correctly. I'm not sure if the VSCode language server handles this better, but I would expect it to have similar problems.
By specifying the return-type explicitly, the language-servers can easily deduce the type of the response.