Fix the JSDoc return type for getEntityRecords (#21630)

* Fix the JSDoc return type for getEntityRecords `getEntityRecords` can actually return null based on the return type of `getQueriedItems` which it calls. I can confirm it behaves this way in the implementation so its a bug with JSDoc type for getEntityRecords. I did wonder if this would be desired behaviour though. Since getEntityRecords is a selector I think it could make more sense for it to always return an empty array to represent its empty state. * Run docs:build
WordPress · Apr 17, 2020 · 6074400 · 6074400
1 parent a32e961
commit 6074400
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/designers-developers/developers/data/data-core.md b/docs/designers-developers/developers/data/data-core.md
@@ -212,7 +212,7 @@ _Parameters_
 
 _Returns_
 
--   `Array`: Records.
+-   `?Array`: Records.
 
 <a name="getLastEntitySaveError" href="#getLastEntitySaveError">#</a> **getLastEntitySaveError**
 

diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -437,7 +437,7 @@ _Parameters_
 
 _Returns_
 
--   `Array`: Records.
+-   `?Array`: Records.
 
 <a name="getLastEntitySaveError" href="#getLastEntitySaveError">#</a> **getLastEntitySaveError**
 

diff --git a/packages/core-data/src/selectors.js b/packages/core-data/src/selectors.js
@@ -179,7 +179,7 @@ export const getRawEntityRecord = createSelector(
  * @param {string}  name   Entity name.
  * @param {?Object} query  Optional terms query.
  *
- * @return {Array} Records.
+ * @return {?Array} Records.
  */
 export function getEntityRecords( state, kind, name, query ) {
 	const queriedState = get( state.entities.data, [