update jsdoc eslint and remove *|undefined

Automattic · Jan 20, 2023 · 3f3340c · 3f3340c
1 parent 071c2fe
commit 3f3340c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/client/gutenberg/editor/controller.js b/client/gutenberg/editor/controller.js
@@ -109,7 +109,7 @@ function waitForPreferredEditorView( context ) {
  *
  * @param {object} context Shared context in the route.
  * @param {Function} next  Next registered callback for the route.
- * @returns {*|undefined}  Whatever the next callback returns.
+ * @returns {*}            Whatever the next callback returns.
  */
 export const authenticate = ( context, next ) => {
 	const state = context.store.getState();

diff --git a/client/state/data-layer/wpcom-http/utils.js b/client/state/data-layer/wpcom-http/utils.js
@@ -10,23 +10,23 @@ const identity = ( data ) => data;
  * Returns response data from an HTTP request success action if available
  *
  * @param {object} action may contain HTTP response data
- * @returns {*|undefined} response data if available
+ * @returns {*} response data if available
  */
 export const getData = ( action ) => get( action, 'meta.dataLayer.data', undefined );
 
 /**
  * Returns error data from an HTTP request failure action if available
  *
  * @param {object} action may contain HTTP response error data
- * @returns {*|undefined} error data if available
+ * @returns {*} error data if available
  */
 export const getError = ( action ) => get( action, 'meta.dataLayer.error', undefined );
 
 /**
  * Returns (response) headers data from an HTTP request action if available
  *
  * @param   {object}      action Request action for which to retrieve HTTP response headers
- * @returns {*|undefined}        Headers data if available
+ * @returns {*} Headers data if available
  */
 export const getHeaders = ( action ) => get( action, 'meta.dataLayer.headers', undefined );
 
@@ -48,7 +48,7 @@ export const getProgress = ( action ) => get( action, 'meta.dataLayer.progress',
  * Returns stream record from an HTTP request action if available
  *
  * @param {object} action may contain stream record
- * @returns {*|undefined} response data if available
+ * @returns {*} response data if available
  */
 export const getStreamRecord = ( action ) =>
 	get( action, 'meta.dataLayer.streamRecord', undefined );

diff --git a/package.json b/package.json
@@ -240,7 +240,7 @@
 		"eslint-plugin-import": "^2.25.4",
 		"eslint-plugin-inclusive-language": "^2.2.0",
 		"eslint-plugin-jest": "^25.3.4",
-		"eslint-plugin-jsdoc": "^39.6.6",
+		"eslint-plugin-jsdoc": "^39.6.7",
 		"eslint-plugin-jsx-a11y": "^6.5.1",
 		"eslint-plugin-md": "^1.0.19",
 		"eslint-plugin-mocha": "^10.0.3",

diff --git a/packages/eslint-plugin-wpcalypso/package.json b/packages/eslint-plugin-wpcalypso/package.json
@@ -27,7 +27,7 @@
 		"@babel/core": ">=7.17.5",
 		"eslint": ">=8.6.0",
 		"eslint-plugin-inclusive-language": "^2.2.0",
-		"eslint-plugin-jsdoc": "^39.6.6",
+		"eslint-plugin-jsdoc": "^39.6.7",
 		"eslint-plugin-react": "^7.28.0",
 		"eslint-plugin-react-hooks": "^4.3.0"
 	},

diff --git a/yarn.lock b/yarn.lock
@@ -15826,9 +15826,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"eslint-plugin-jsdoc@npm:^39.6.6":
-  version: 39.6.6
-  resolution: "eslint-plugin-jsdoc@npm:39.6.6"
+"eslint-plugin-jsdoc@npm:^39.6.7":
+  version: 39.6.7
+  resolution: "eslint-plugin-jsdoc@npm:39.6.7"
   dependencies:
     "@es-joy/jsdoccomment": ~0.36.1
     comment-parser: 1.3.1
@@ -15839,7 +15839,7 @@ __metadata:
     spdx-expression-parse: ^3.0.1
   peerDependencies:
     eslint: ^7.0.0 || ^8.0.0
-  checksum: 8b8eec98e0c5ef23e791980092d7f9582fb847b8eecf4478008ec2f6b2c1bbcf56b2eeb286d7eec93c2dd77f385e3b362dea8891b2a7a75eb5bd36fed61127e3
+  checksum: c0973999454d5bd3827d669eb2d88a33dea81e4d282312535188d7982684f401b1db7116214438e30edb5c61f6c72ff7c3a07f0b97ed3d3147b1f5eb8df2eeb9
   languageName: node
   linkType: hard
 
@@ -15980,7 +15980,7 @@ __metadata:
     "@babel/core": ">=7.17.5"
     eslint: ">=8.6.0"
     eslint-plugin-inclusive-language: ^2.2.0
-    eslint-plugin-jsdoc: ^39.6.6
+    eslint-plugin-jsdoc: ^39.6.7
     eslint-plugin-react: ^7.28.0
     eslint-plugin-react-hooks: ^4.3.0
   peerDependenciesMeta:
@@ -33687,7 +33687,7 @@ resolve@^2.0.0-next.3:
     eslint-plugin-import: ^2.25.4
     eslint-plugin-inclusive-language: ^2.2.0
     eslint-plugin-jest: ^25.3.4
-    eslint-plugin-jsdoc: ^39.6.6
+    eslint-plugin-jsdoc: ^39.6.7
     eslint-plugin-jsx-a11y: ^6.5.1
     eslint-plugin-md: ^1.0.19
     eslint-plugin-mocha: ^10.0.3