Skip to content
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

[core-data] Document and add types for dynamic actions and selectors. #66997

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

manzoorwanijk
Copy link
Contributor

What?

Define the type declarations for dynamic selectors and actions for core-data package`

Why?

The dynamic selectors cause errors when used in TypeScript because TS can't find those defined anywhere.

How?

The PR creates TS definition declarations for all the dynamic selectors and some useful actions

Testing Instructions

  • Use the dynamic selectors or actions in TypeScript files
  • Confirm that TS doesn't show an error

Example

import { store as coreStore } from '@wordpress/core-data';
import { select } from '@wordpress/data';

const { getUser, getUsers } = select( coreStore );

Testing Instructions for Keyboard

Screenshots or screencast

image

We will now have auto-completions for entity selectors
image

Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Copy link

github-actions bot commented Nov 14, 2024

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: manzoorwanijk <[email protected]>
Co-authored-by: sirreal <[email protected]>

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

Comment on lines +10 to +14
export interface PostType< C extends Context > {
/**
* All capabilities used by the post type.
*/
capabilities: Record< string, string >;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description of these fields is copied from core REST API schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants