fix use undefined instead of void in jsdoc return types to satisfy require-returns-check

fabiankaegy · fabiankaegy · commit 64e995794868 · 2023-01-27T16:03:24.000+01:00
diff --git a/packages/block-editor/src/components/block-mover/mover-description.js b/packages/block-editor/src/components/block-mover/mover-description.js
@@ -32,7 +32,7 @@ const getMovementDirection = ( moveDirection, orientation ) => {
  * @param {string}  orientation   The orientation of the block movers, vertical or
  *                                horizontal.
  *
- * @return {string | void} Label for the block movement controls.
+ * @return {string | undefined} Label for the block movement controls.
  */
 export function getBlockMoverDescription(
 	selectedCount,
@@ -227,7 +227,7 @@ export function getBlockMoverDescription(
  * @param {string}  orientation   The orientation of the block movers, vertical or
  *                                horizontal.
  *
- * @return {string | void} Label for the block movement controls.
+ * @return {string | undefined} Label for the block movement controls.
  */
 export function getMultiBlockMoverDescription(
 	selectedCount,
diff --git a/packages/block-editor/src/components/block-switcher/utils.js b/packages/block-editor/src/components/block-switcher/utils.js
@@ -13,7 +13,7 @@ import { __experimentalGetBlockAttributesNamesByRole as getBlockAttributesNamesB
  * @param {string}  selectedBlockName The block's name to use for matching condition.
  * @param {Set}     consumedBlocks    A set holding the previously matched/consumed blocks.
  *
- * @return {WPBlock | void} The matched block if found or nothing(`undefined`).
+ * @return {WPBlock | undefined} The matched block if found or nothing(`undefined`).
  */
 export const getMatchingBlockByName = (
 	block,
diff --git a/packages/block-editor/src/store/reducer.js b/packages/block-editor/src/store/reducer.js
@@ -1756,7 +1756,7 @@ export function lastBlockAttributesChange( state = null, action ) {
  * @param {?string} state  Current state.
  * @param {Object}  action Dispatched action.
  *
- * @return {string | void} Updated state.
+ * @return {string | undefined} Updated state.
  */
 export function automaticChangeStatus( state, action ) {
 	switch ( action.type ) {
diff --git a/packages/block-library/src/table/state.js b/packages/block-library/src/table/state.js
@@ -30,7 +30,7 @@ export function createTable( { rowCount, columnCount } ) {
  *
  * @param {Object} state Current table state.
  *
- * @return {Object | void} The first table row.
+ * @return {Object | undefined} The first table row.
  */
 export function getFirstRow( state ) {
 	if ( ! isEmptyTableSection( state.head ) ) {
diff --git a/packages/blocks/src/api/validation/index.js b/packages/blocks/src/api/validation/index.js
@@ -548,7 +548,7 @@ export const isEqualTokensOfType = {
  *
  * @param {Object[]} tokens Set of tokens to search.
  *
- * @return {Object | void} Next non-whitespace token.
+ * @return {Object | undefined} Next non-whitespace token.
  */
 export function getNextNonWhitespaceToken( tokens ) {
 	let token;

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ import { __experimentalGetBlockAttributesNamesByRole as getBlockAttributesNamesB`
`13`	`13`	`* @param {string} selectedBlockName The block's name to use for matching condition.`
`14`	`14`	`* @param {Set} consumedBlocks A set holding the previously matched/consumed blocks.`
`15`	`15`	`*`
`16`		- * @return {WPBlock \| void} The matched block if found or nothing(`undefined`).
	`16`	+ * @return {WPBlock \| undefined} The matched block if found or nothing(`undefined`).
`17`	`17`	`*/`
`18`	`18`	`export const getMatchingBlockByName = (`
`19`	`19`	`block,`
Original file line number	Diff line number	Diff line change
`@@ -1756,7 +1756,7 @@ export function lastBlockAttributesChange( state = null, action ) {`
`1756`	`1756`	`* @param {?string} state Current state.`
`1757`	`1757`	`* @param {Object} action Dispatched action.`
`1758`	`1758`	`*`
`1759`		`- * @return {string \| void} Updated state.`
	`1759`	`+ * @return {string \| undefined} Updated state.`
`1760`	`1760`	`*/`
`1761`	`1761`	`export function automaticChangeStatus( state, action ) {`
`1762`	`1762`	`switch ( action.type ) {`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export function createTable( { rowCount, columnCount } ) {`
`30`	`30`	`*`
`31`	`31`	`* @param {Object} state Current table state.`
`32`	`32`	`*`
`33`		`- * @return {Object \| void} The first table row.`
	`33`	`+ * @return {Object \| undefined} The first table row.`
`34`	`34`	`*/`
`35`	`35`	`export function getFirstRow( state ) {`
`36`	`36`	`if ( ! isEmptyTableSection( state.head ) ) {`
Original file line number	Diff line number	Diff line change
`@@ -548,7 +548,7 @@ export const isEqualTokensOfType = {`
`548`	`548`	`*`
`549`	`549`	`* @param {Object[]} tokens Set of tokens to search.`
`550`	`550`	`*`
`551`		`- * @return {Object \| void} Next non-whitespace token.`
	`551`	`+ * @return {Object \| undefined} Next non-whitespace token.`
`552`	`552`	`*/`
`553`	`553`	`export function getNextNonWhitespaceToken( tokens ) {`
`554`	`554`	`let token;`