add tscheck annotations, add JSDoc types to makeFaunaRequest #379
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
mwilde345
reviewed
Oct 7, 2024
| port, | ||
| scheme: protocol?.replace(/:$/, ""), | ||
| port: Number(port), | ||
| scheme: /** @type {('http'|'https')} */ (scheme), |
There was a problem hiding this comment.
is this the best way to type it? Can we type the Client?
There was a problem hiding this comment.
The v4 driver client has the type 'http' | 'https' | undefined, which seems pretty accurate to me. I don't think we want to loosen that type.
There was a problem hiding this comment.
oh was mostly referring to the syntax/inline comment way of doing things
mwilde345
approved these changes
Oct 7, 2024
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.
Ticket(s): FE-###
Problem
Explain the context and why you're making that change. What is the problem you're trying to solve? In some cases there is not a problem and this can be thought of being the motivation for your change.
Solution
Describe the modifications you've done.
Result
What will change as a result of your pull request? Note that sometimes this section is unnecessary because it is self-explanatory based on the solution.
Testing
Describe the manual and automated tests you completed to verify the change is working as expected.