Skip to content

Add typing to iAPI's getConfig() #71692

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.

Sign up for GitHub

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

Jump to bottom
Open
Aljullu wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Add typing to iAPI's getConfig() #71692

Aljullu wants to merge 2 commits into from

Conversation

@Aljullu
Copy link
Contributor

@Aljullu Aljullu commented Sep 16, 2025

What?

Initially discussed in woocommerce/woocommerce@3b133f2#r165804930.

This PR types the Interactivity API's getConfig() function, similar to how it's done for getContext().

Why?

This allows consumers to consume it like this:

const config = getConfig< ConfigType >();

instead of missing the types or having to add a type assertion as

const config = getConfig() as ConfigType;

Testing Instructions

  1. Add this code somewhere in the codebase:
type ConfigType = {
	prop: string;
};

const config = getConfig< ConfigType >();
  1. Verify you don't get a TS error mentioning Expected 0 type arguments, but got 1..

@Aljullu Aljullu self-assigned this Sep 16, 2025
@github-actions
Copy link

github-actions bot commented Sep 16, 2025

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: Aljullu <[email protected]>

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

@Aljullu Aljullu added [Type] Code Quality Issues or PRs that relate to code quality [Feature] Interactivity API API to add frontend interactivity to blocks. labels Sep 16, 2025
Aljullu referenced this pull request in woocommerce/woocommerce Sep 16, 2025
@Aljullu
Add types to getConfig()
3b133f2
@github-actions
Copy link

github-actions bot commented Sep 16, 2025

Flaky tests detected in 072e843.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/17763767596
📝 Reported issues:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@luisherranz luisherranz Awaiting requested review from luisherranz luisherranz is a code owner

@DAreRodz DAreRodz Awaiting requested review from DAreRodz DAreRodz is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@Aljullu Aljullu

Labels

[Feature] Interactivity API API to add frontend interactivity to blocks. [Type] Code Quality Issues or PRs that relate to code quality

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Aljullu