api-fetch: Type several of the middlewares #29719
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
sarayourfriend
added
[Package] API fetch
75 tasks
sarayourfriend
force-pushed
the
add/types-api-fetch-namespace
branch
from
61bf58f to
ea308f8
Compare
|
Size Change: -1 B (0%) Total Size: 1.4 MB
ℹ️ View Unchanged
|
tyxla
approved these changes
Mar 16, 2021
| * @param {import('../types').ApiFetchRequestProps} options | ||
| * @param {(options: import('../types').ApiFetchRequestProps) => import('../types').ApiFetchRequestProps} next | ||
| * @return {import('../types').ApiFetchRequestProps} The enhanced request. | ||
| * @type {import('../types').ApiFetchMiddleware & { nonce: string }} |
There was a problem hiding this comment.
I guess we could do a bit better with typing the { nonce: string } part.
There was a problem hiding this comment.
What would you suggest? This is the only way I know how to type a function with extra properties on it other than using a new interface:
interface ApiFetchNonceMiddleware extends ApiFetchMiddleware {
nonce: string;
}but that's effectively the same as what I have inline here.
There was a problem hiding this comment.
I agree, that's not much better 👍 Let's keep as-is for now
|
Thanks for the review @tyxla! |
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.
Description
Adds type checking to the following middleware:
It also simplifies the types used in the
noncemiddleware.It also corrects the return types for the
ApiFetchMiddlewareand itsnextfunction. These eventually always return aPromiseas the final middleware eventually calls to the default handler. Each middleware itself can also return a Promise instead of callingnext(seepreloadingandmedia-upload).Part of #18838
How has this been tested?
Type check passes. No runtime changes except converting some
functions to arrow functions so that we can type them asApiFetchMiddlewareinstead of having to annotate the parameter types manually (see the changes to thenoncemiddleware for an example of this).Types of changes
Non-breaking changes.
Checklist: