Fixed incorrect type annotations in @wordpress/data (#46881)

* Fixed incorrect type annotations in @wordpress/data * Prettier fix * Updated @wordpress/data readme
WordPress · Feb 7, 2023 · ac2e68f · ac2e68f · github-actions · Feb 7, 2023
1 parent 21da6b3
commit ac2e68f
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 8 deletions.
diff --git a/packages/data/README.md b/packages/data/README.md
@@ -500,6 +500,10 @@ import { store as myCustomStore } from 'my-custom-store';
 dispatch( myCustomStore ).setPrice( 'hammer', 9.75 );
 ```
 
+_Type_
+
+-   `(storeNameOrDescriptor: StoreDescriptor|string) => Object`
+
 _Parameters_
 
 -   _storeNameOrDescriptor_ `StoreDescriptor|string`: The store descriptor. The legacy calling convention of passing the store name is also supported.
@@ -647,6 +651,10 @@ import { store as myCustomStore } from 'my-custom-store';
 select( myCustomStore ).getPrice( 'hammer' );
 ```
 
+_Type_
+
+-   `(storeNameOrDescriptor: StoreDescriptor|string) => Object`
+
 _Parameters_
 
 -   _storeNameOrDescriptor_ `StoreDescriptor|string`: The store descriptor. The legacy calling convention of passing the store name is also supported.

diff --git a/packages/data/src/components/use-dispatch/use-dispatch.js b/packages/data/src/components/use-dispatch/use-dispatch.js
@@ -5,7 +5,7 @@ import useRegistry from '../registry-provider/use-registry';
 
 /**
  * @typedef {import('../../types').StoreDescriptor<StoreConfig>} StoreDescriptor
- * @template StoreConfig
+ * @template {import('../../types').AnyConfig} StoreConfig
  */
 /**
  * @typedef {import('../../types').UseDispatchReturn<StoreNameOrDescriptor>} UseDispatchReturn

diff --git a/packages/data/src/components/use-select/index.js b/packages/data/src/components/use-select/index.js
@@ -21,17 +21,18 @@ const renderQueue = createQueue();
 
 /**
  * @typedef {import('../../types').StoreDescriptor<C>} StoreDescriptor
- * @template C
+ * @template {import('../../types').AnyConfig} C
  */
 /**
  * @typedef {import('../../types').ReduxStoreConfig<State,Actions,Selectors>} ReduxStoreConfig
- * @template State,Actions,Selectors
+ * @template State,Selectors
+ * @template {Record<string,import('../../types').ActionCreator>} Actions
  */
+/** @typedef {import('../../types').MapSelect} MapSelect */
 /**
  * @typedef {import('../../types').UseSelectReturn<T>} UseSelectReturn
- * @template T
+ * @template {MapSelect|StoreDescriptor<any>} T
  */
-/** @typedef {import('../../types').MapSelect} MapSelect */
 
 function Store( registry, suspense ) {
 	const select = suspense ? registry.suspendSelect : registry.select;

diff --git a/packages/data/src/index.js b/packages/data/src/index.js
@@ -98,6 +98,8 @@ export const combineReducers = turboCombineReducers;
  * ```
  *
  * @return {Object} Object containing the store's selectors.
+ *
+ * @type {(storeNameOrDescriptor: StoreDescriptor|string) => Object}
  */
 export const select = defaultRegistry.select;
 
@@ -154,6 +156,8 @@ export const suspendSelect = defaultRegistry.suspendSelect;
  * dispatch( myCustomStore ).setPrice( 'hammer', 9.75 );
  * ```
  * @return {Object} Object containing the action creators.
+ *
+ * @type {(storeNameOrDescriptor: StoreDescriptor|string) => Object}
  */
 export const dispatch = defaultRegistry.dispatch;
 

diff --git a/packages/data/src/redux-store/index.js b/packages/data/src/redux-store/index.js
@@ -27,11 +27,12 @@ import * as metadataActions from './metadata/actions';
 /** @typedef {import('../types').DataRegistry} DataRegistry */
 /**
  * @typedef {import('../types').StoreDescriptor<C>} StoreDescriptor
- * @template C
+ * @template {import('../types').AnyConfig} C
  */
 /**
  * @typedef {import('../types').ReduxStoreConfig<State,Actions,Selectors>} ReduxStoreConfig
- * @template State,Actions,Selectors
+ * @template State,Selectors
+ * @template {Record<string,import('../../types').ActionCreator>} Actions
  */
 
 const trimUndefinedValues = ( array ) => {
@@ -100,7 +101,8 @@ function createResolversCache() {
  * } );
  * ```
  *
- * @template State,Actions,Selectors
+ * @template State,Selectors
+ * @template {Record<string,import('../../types').ActionCreator>} Actions
  * @param {string}                                    key     Unique namespace identifier.
  * @param {ReduxStoreConfig<State,Actions,Selectors>} options Registered store options, with properties
  *                                                            describing reducer, actions, selectors,