summaryrefslogtreecommitdiff
path: root/lib/https.js
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2022-10-30 09:03:10 -0700
committerNode.js GitHub Bot <github-bot@iojs.org>2022-11-07 07:04:29 +0000
commitc370ec124c6b3ab5f094937246f5a0e31863fb66 (patch)
tree2e5d27337fc6e9c104e33e7814128285810daee7 /lib/https.js
parent73a51125832e3dcf50d1692814635e2daf0b3398 (diff)
downloadnode-new-c370ec124c6b3ab5f094937246f5a0e31863fb66.tar.gz
lib: fix JSDoc issues
Updating ESLint and dependencies will start flagging a few additional JSDoc issues. One or two of these are simple fixes. The ESM stuff requires throwing explicitly in JSDoc'ed functions rather than calling another function to throw. I think this makes the code easier to understand--you don't need to know that a particular function that starts with `throwsIf` *might* throw but something that starts with `throwsAnythingElse` will always throw. Instead, it's right there in the code. This also might make it easier to improve stack traces if that's something we'd like to do at some point. PR-URL: https://github.com/nodejs/node/pull/45243 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
Diffstat (limited to 'lib/https.js')
-rw-r--r--lib/https.js2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/https.js b/lib/https.js
index 0ecd13b1dd..e871b35bca 100644
--- a/lib/https.js
+++ b/lib/https.js
@@ -178,7 +178,7 @@ function createConnection(port, host, options) {
* maxCachedSessions?: number;
* servername?: string;
* }} [options]
- * @returns {Agent}
+ * @constructor
*/
function Agent(options) {
if (!(this instanceof Agent))