Interactivity API : Refactor interactivity-router to TS #61730
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
| const getPagePath = ( url ) => { | ||
| const u = new URL( url, window.location ); | ||
| const getPagePath = ( url: string ) => { | ||
| const u = new URL( url, window.location.href ); |
There was a problem hiding this comment.
The URL() constructor automatically converts window.location to string using window.location.toString(). However, TS is not happy about it so I explicitly pass href.
Comment on lines
+88
to
89
| // @ts-ignore | ||
| if ( process.env.IS_GUTENBERG_PLUGIN ) { |
There was a problem hiding this comment.
I had to put a couple of @ts-ignore directives so that TS is happy with process.env.
Hopefully once #61486 is merged we can call globalThis.IS_GUTENBERG_PLUGIN and remove the @ts-ignores.
|
Size Change: +578 B (+0.03%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
michalczaplinski
added
[Type] Code Quality
| pages.set( pagePath, fetchPage( pagePath, options ) ); | ||
| pages.set( | ||
| pagePath, | ||
| fetchPage( pagePath, { html: options.html } ) |
There was a problem hiding this comment.
fetchPage() signature is:
const fetchPage = async ( url: string, { html }: { html: string } )TS is not happy if we pass the whole options object which contains additional properties.
michalczaplinski
changed the title
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
| * @param {Document} doc The document from which to fetch head assets. It should support standard DOM querying methods. | ||
| * @param {Map} headElements A map of head elements to modify tracking the URLs of already processed assets to avoid duplicates. | ||
| * @param {Document} doc The document from which to fetch head assets. It should support standard DOM querying methods. | ||
| * @param {Map} headElements A map of head elements to modify tracking the URLs of already processed assets to avoid duplicates. |
There was a problem hiding this comment.
In Interactivity API package we are removing the type from the jsdoc to only leave it in TS.
cbravobernal
approved these changes
May 20, 2024
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
) * Migrate interactivity-router to TS * Migrate head.js to TypeScript * chore: Update headElements type in fetchHeadAssets function * chore: Update getTagId function in head.ts * Removed jsdocs types --------- Co-authored-by: michalczaplinski <czapla@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org>
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.
What?
Closes #61371
Migrate the
@wordpress/interactivity-routerto TypeScript.Why?
To improve the developer experience.
Testing Instructions
This PR has no functional changes other than the TS types. All functionality should remain identical as before.