Fixes return type for getEntitiesByKind (#30639)

The return type was specified as boolean, but the data is being passed to the lodash filter function and returning its result which will be an Array<Object> not a boolean. Closes #29260
WordPress · Apr 9, 2021 · 2aefc5b · 2aefc5b
1 parent b6272d9
commit 2aefc5b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -376,7 +376,7 @@ _Parameters_
 
 _Returns_
 
--   `boolean`: Whether the entities are loaded
+-   `Array<Object>`: Array of entities with config matching kind.
 
 <a name="getEntity" href="#getEntity">#</a> **getEntity**
 

diff --git a/packages/core-data/src/selectors.js b/packages/core-data/src/selectors.js
@@ -110,7 +110,7 @@ export const getUserQueryResults = createSelector(
  * @param {Object} state   Data state.
  * @param {string} kind  Entity kind.
  *
- * @return {boolean} Whether the entities are loaded
+ * @return {Array<Object>} Array of entities with config matching kind.
  */
 export function getEntitiesByKind( state, kind ) {
 	return filter( state.entities.config, { kind } );