lib: use consistent types in JSDoc @returns

PR-URL: #41089 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Feb 1, 2022 · eda57a9 · eda57a9
1 parent ecc086c
commit eda57a9
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 4 deletions.
diff --git a/lib/assert.js b/lib/assert.js
@@ -129,7 +129,6 @@ function innerFail(obj) {
  * @param {string | Error} [message]
  * @param {string} [operator]
  * @param {Function} [stackStartFn]
- * @returns {never}
  */
 function fail(actual, expected, message, operator, stackStartFn) {
   const argsLen = arguments.length;

diff --git a/lib/events.js b/lib/events.js
@@ -79,7 +79,7 @@ const kMaxEventTargetListenersWarned =
 /**
  * Creates a new `EventEmitter` instance.
  * @param {{ captureRejections?: boolean; }} [opts]
- * @returns {EventEmitter}
+ * @constructs {EventEmitter}
  */
 function EventEmitter(opts) {
   EventEmitter.init.call(this, opts);

diff --git a/lib/fs.js b/lib/fs.js
@@ -239,7 +239,7 @@ function access(path, mode, callback) {
  * directory specified by `path`.
  * @param {string | Buffer | URL} path
  * @param {number} [mode]
- * @returns {void | never}
+ * @returns {void}
  */
 function accessSync(path, mode) {
   path = getValidatedPath(path);

diff --git a/lib/internal/modules/esm/resolve.js b/lib/internal/modules/esm/resolve.js
@@ -128,7 +128,7 @@ function emitTrailingSlashPatternDeprecation(match, pjsonUrl, isExports, base) {
  * @param {URL} packageJSONUrl
  * @param {string | URL | undefined} base
  * @param {string} main
- * @returns
+ * @returns {void}
  */
 function emitLegacyIndexDeprecation(url, packageJSONUrl, base, main) {
   const format = defaultGetFormat(url);