From 706c87db50883de9b92a40e9042efc9eaa8ffe60 Mon Sep 17 00:00:00 2001 From: Moshe Atlow Date: Sun, 30 Apr 2023 07:13:04 +0300 Subject: [PATCH] tools: fix jsdoc lint MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/47789 Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca Reviewed-By: Moshe Atlow Reviewed-By: Tobias Nießen Reviewed-By: Colin Ihrig Reviewed-By: Mestery --- benchmark/common.js | 1 - lib/internal/async_hooks.js | 1 - lib/internal/errors.js | 5 ----- lib/internal/modules/esm/fetch_module.js | 1 - lib/internal/modules/esm/loader.js | 4 +--- lib/internal/per_context/primordials.js | 1 - lib/internal/policy/manifest.js | 1 - lib/internal/util/inspect.js | 1 - lib/internal/util/parse_args/parse_args.js | 5 ----- lib/internal/util/parse_args/utils.js | 1 - lib/internal/validators.js | 1 - lib/os.js | 1 - lib/string_decoder.js | 4 ---- lib/util.js | 1 - test/async-hooks/hook-checks.js | 1 - test/common/assertSnapshot.js | 1 - 16 files changed, 1 insertion(+), 29 deletions(-) diff --git a/benchmark/common.js b/benchmark/common.js index 71c11e21aea1e0..ac8e88917bc8ad 100644 --- a/benchmark/common.js +++ b/benchmark/common.js @@ -374,7 +374,6 @@ function getUrlData(withBase) { * The 'wpt' type contains about 400 data points when `withBase` is true, * and 200 data points when `withBase` is false. * Other types contain 200 data points with or without base. - * * @param {string} type Type of the data, 'wpt' or a key of `urls` * @param {number} e The repetition of the data, as exponent of 2 * @param {boolean} withBase Whether to include a base URL diff --git a/lib/internal/async_hooks.js b/lib/internal/async_hooks.js index a25c772f21b491..9294773fe4126a 100644 --- a/lib/internal/async_hooks.js +++ b/lib/internal/async_hooks.js @@ -444,7 +444,6 @@ function clearDefaultTriggerAsyncId() { /** * Sets a default top level trigger ID to be used - * * @template {Array} T * @template {unknown} R * @param {number} triggerAsyncId diff --git a/lib/internal/errors.js b/lib/internal/errors.js index be91a4b1f917e5..9c9eae6848b76f 100644 --- a/lib/internal/errors.js +++ b/lib/internal/errors.js @@ -499,7 +499,6 @@ const captureLargerStackTrace = hideStackFrames( * function UVException using a context object with data assembled in C++. * The goal is to migrate them to ERR_* errors later when compatibility is * not a concern. - * * @param {object} ctx * @returns {Error} */ @@ -551,7 +550,6 @@ const uvException = hideStackFrames(function uvException(ctx) { * This creates an error compatible with errors produced in the C++ * This function should replace the deprecated * `exceptionWithHostPort()` function. - * * @param {number} err - A libuv error number * @param {string} syscall * @param {string} address @@ -591,7 +589,6 @@ const uvExceptionWithHostPort = hideStackFrames( /** * This used to be util._errnoException(). - * * @param {number} err - A libuv error number * @param {string} syscall * @param {string} [original] @@ -725,7 +722,6 @@ let maxStack_ErrorMessage; * Returns true if `err.name` and `err.message` are equal to engine-specific * values indicating max call stack size has been exceeded. * "Maximum call stack size exceeded" in V8. - * * @param {Error} err * @returns {boolean} */ @@ -857,7 +853,6 @@ class AbortError extends Error { /** * This creates a generic Node.js error. - * * @param {string} message The error message. * @param {object} errorProperties Object with additional properties to be added to the error. * @returns {Error} diff --git a/lib/internal/modules/esm/fetch_module.js b/lib/internal/modules/esm/fetch_module.js index d79e5a5eb99e84..74d2d2599dbd45 100644 --- a/lib/internal/modules/esm/fetch_module.js +++ b/lib/internal/modules/esm/fetch_module.js @@ -235,7 +235,6 @@ async function isLocalAddress(hostname) { * * In cases where the request & response have already settled, this returns the * cache value synchronously. - * * @param {URL} parsed * @param {ESModuleContext} context * @returns {ReturnType} diff --git a/lib/internal/modules/esm/loader.js b/lib/internal/modules/esm/loader.js index 98ddf3640effe5..d2a3647e3c2168 100644 --- a/lib/internal/modules/esm/loader.js +++ b/lib/internal/modules/esm/loader.js @@ -497,7 +497,6 @@ class ESMLoader { * * This method must NOT be renamed: it functions as a dynamic import on a * loader module. - * * @param {string | string[]} specifiers Path(s) to the module. * @param {string} parentURL Path of the parent importing the module. * @param {Record} importAssertions Validations for the @@ -548,9 +547,9 @@ class ESMLoader { * Internally, this behaves like a backwards iterator, wherein the stack of * hooks starts at the top and each call to `nextLoad()` moves down 1 step * until it reaches the bottom or short-circuits. - * * @param {URL['href']} url The URL/path of the module to be loaded * @param {object} context Metadata about the module + * * @returns {{ format: ModuleFormat, source: ModuleSource }} */ async load(url, context = {}) { @@ -778,7 +777,6 @@ class ESMLoader { * Internally, this behaves like a backwards iterator, wherein the stack of * hooks starts at the top and each call to `nextResolve()` moves down 1 step * until it reaches the bottom or short-circuits. - * * @param {string} originalSpecifier The specified URL path of the module to * be resolved. * @param {string} [parentURL] The URL path of the module's parent. diff --git a/lib/internal/per_context/primordials.js b/lib/internal/per_context/primordials.js index d7a846b29e6631..cd23e8aa804989 100644 --- a/lib/internal/per_context/primordials.js +++ b/lib/internal/per_context/primordials.js @@ -314,7 +314,6 @@ const { * Because these functions are used by `makeSafe`, which is exposed on the * `primordials` object, it's important to use const references to the * primordials that they use. - * * @template {Iterable} T * @template {*} TReturn * @template {*} TNext diff --git a/lib/internal/policy/manifest.js b/lib/internal/policy/manifest.js index 508e1802dbf47c..698971ee57f2b1 100644 --- a/lib/internal/policy/manifest.js +++ b/lib/internal/policy/manifest.js @@ -417,7 +417,6 @@ class Manifest { * the prototype to `null` for values or by running prior to any user code. * * `manifestURL` is a URL to resolve relative locations against. - * * @param {object} obj * @param {string} manifestHREF */ diff --git a/lib/internal/util/inspect.js b/lib/internal/util/inspect.js index 20ff8aed00274c..da71e4513d99a3 100644 --- a/lib/internal/util/inspect.js +++ b/lib/internal/util/inspect.js @@ -302,7 +302,6 @@ function getUserOptions(ctx, isCrossContext) { /** * Echos the value of any input. Tries to print the value out * in the best way possible given the different types. - * * @param {any} value The value to print out. * @param {object} opts Optional options object that alters the output. */ diff --git a/lib/internal/util/parse_args/parse_args.js b/lib/internal/util/parse_args/parse_args.js index 68a9fddff50fd0..6915f256d62aab 100644 --- a/lib/internal/util/parse_args/parse_args.js +++ b/lib/internal/util/parse_args/parse_args.js @@ -73,7 +73,6 @@ function getMainArgs() { /** * In strict mode, throw for possible usage errors like --foo --bar - * * @param {object} token - from tokens as available from parseArgs */ function checkOptionLikeValue(token) { @@ -91,7 +90,6 @@ To specify an option argument starting with a dash use ${example}.`; /** * In strict mode, throw for usage errors. - * * @param {object} config - from config passed to parseArgs * @param {object} token - from tokens as available from parseArgs */ @@ -116,7 +114,6 @@ function checkOptionUsage(config, token) { /** * Store the option value in `values`. - * * @param {string} longOption - long option name e.g. 'foo' * @param {string|undefined} optionValue - value from user args * @param {object} options - option configs, from parseArgs({ options }) @@ -148,7 +145,6 @@ function storeOption(longOption, optionValue, options, values) { /** * Store the default option value in `values`. - * * @param {string} longOption - long option name e.g. 'foo' * @param {string * | boolean @@ -169,7 +165,6 @@ function storeDefaultOption(longOption, optionValue, values) { * - option (along with value, if any) * - positional * - option-terminator - * * @param {string[]} args - from parseArgs({ args }) or mainArgs * @param {object} options - option configs, from parseArgs({ options }) */ diff --git a/lib/internal/util/parse_args/utils.js b/lib/internal/util/parse_args/utils.js index eb70257cfba095..95f787daf1debf 100644 --- a/lib/internal/util/parse_args/utils.js +++ b/lib/internal/util/parse_args/utils.js @@ -173,7 +173,6 @@ function findLongOptionForShort(shortOption, options) { /** * Check if the given option includes a default value * and that option has not been set by the input args. - * * @param {string} longOption - long option name e.g. 'foo' * @param {object} optionConfig - the option configuration properties * @param {object} values - option values returned in `values` by parseArgs diff --git a/lib/internal/validators.js b/lib/internal/validators.js index 5d6f78c2a30ed8..9ffc01e2296803 100644 --- a/lib/internal/validators.js +++ b/lib/internal/validators.js @@ -61,7 +61,6 @@ const modeDesc = 'must be a 32-bit unsigned integer or an octal string'; * converted to 32-bit unsigned integers or non-negative signed integers in the * C++ land, but any value higher than 0o777 will result in platform-specific * behaviors. - * * @param {*} value Values to be validated * @param {string} name Name of the argument * @param {number} [def] If specified, will be returned for invalid values diff --git a/lib/os.js b/lib/os.js index ef41688ee4ed03..34391697b5891c 100644 --- a/lib/os.js +++ b/lib/os.js @@ -126,7 +126,6 @@ function loadavg() { /** * Returns an array of objects containing information about each * logical CPU core. - * * @returns {Array<{ * model: string, * speed: number, diff --git a/lib/string_decoder.js b/lib/string_decoder.js index 475c6adec0676c..2ed2de60de6ee5 100644 --- a/lib/string_decoder.js +++ b/lib/string_decoder.js @@ -54,7 +54,6 @@ const kNativeDecoder = Symbol('kNativeDecoder'); // modules monkey-patch it to support additional encodings /** * Normalize encoding notation - * * @param {string} enc * @returns {"utf8" | "utf16le" | "hex" | "ascii" * | "base64" | "latin1" | "base64url"} @@ -78,7 +77,6 @@ for (let i = 0; i < encodings.length; ++i) * StringDecoder provides an interface for efficiently splitting a series of * buffers into a series of JS strings without breaking apart multi-byte * characters. - * * @param {string} [encoding=utf-8] */ function StringDecoder(encoding) { @@ -90,7 +88,6 @@ function StringDecoder(encoding) { /** * Returns a decoded string, omitting any incomplete multi-bytes * characters at the end of the Buffer, or TypedArray, or DataView - * * @param {string | Buffer | TypedArray | DataView} buf * @returns {string} * @throws {TypeError} Throws when buf is not in one of supported types @@ -112,7 +109,6 @@ StringDecoder.prototype.write = function write(buf) { * Returns any remaining input stored in the internal buffer as a string. * After end() is called, the stringDecoder object can be reused for new * input. - * * @param {string | Buffer | TypedArray | DataView} [buf] * @returns {string} */ diff --git a/lib/util.js b/lib/util.js index b00e2b0b1d6c56..f71089c6b4e6dc 100644 --- a/lib/util.js +++ b/lib/util.js @@ -233,7 +233,6 @@ function log(...args) { * during bootstrapping this function needs to be rewritten using some native * functions as prototype setup using normal JavaScript does not work as * expected during bootstrapping (see mirror.js in r114903). - * * @param {Function} ctor Constructor function which needs to inherit the * prototype. * @param {Function} superCtor Constructor function to inherit prototype from. diff --git a/test/async-hooks/hook-checks.js b/test/async-hooks/hook-checks.js index 6ad79bc68e8ac1..833cdd8de300e1 100644 --- a/test/async-hooks/hook-checks.js +++ b/test/async-hooks/hook-checks.js @@ -5,7 +5,6 @@ const assert = require('assert'); /** * Checks the expected invocations against the invocations that actually * occurred. - * * @name checkInvocations * @function * @param {object} activity including timestamps for each life time event, diff --git a/test/common/assertSnapshot.js b/test/common/assertSnapshot.js index 4986103fe92245..962e7d649a9663 100644 --- a/test/common/assertSnapshot.js +++ b/test/common/assertSnapshot.js @@ -48,7 +48,6 @@ async function assertSnapshot(actual, filename = process.argv[1]) { * both of which can be used as an example for writing your own * compose multiple transforms by passing them as arguments to the transform function: * assertSnapshot.transform(assertSnapshot.replaceStackTrace, assertSnapshot.replaceWindowsLineEndings) - * * @param {string} filename * @param {function(string): string} [transform] * @returns {Promise}