Skip to content

TypeScript: migrate dom-ready package to TS #70467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

kushagra-goyal-14
Copy link
Contributor

What?

Part of #67691

Migrating the dom-ready package to TypeScript.

Why?

To enhance DX and add type safety.

How?

By porting the code and tests to TypeScript, inlining the () => void callback type and removing the obsolete @typedef Callback.

Since Doctrine was removed from docgen in PR #28615, the tooling now understands inline function types. This completes the original TODO to drop the Callback typedef and use () => void directly in JSDoc and signatures.

Testing Instructions

Typecheck and unit tests.

Copy link

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: kushagra-goyal-14 <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @kushagra-goyal-14! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jun 18, 2025
@kushagra-goyal-14
Copy link
Contributor Author

Seems like #67671 has already migrated this package to TS and is open, thus closing this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant