Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tools: enable jsdoc/require-property-description lint rule #45370

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,6 @@ module.exports = {
'jsdoc/require-param': 'off',
'jsdoc/check-tag-names': 'off',
'jsdoc/require-returns': 'off',
'jsdoc/require-property-description': 'off',

// Custom rules from eslint-plugin-node-core
'node-core/no-unescaped-regexp-dot': 'error',
Expand Down
44 changes: 22 additions & 22 deletions lib/http.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,28 +62,28 @@ function createServer(opts, requestListener) {

/**
* @typedef {object} HTTPRequestOptions
* @property {httpAgent.Agent | boolean} [agent]
* @property {string} [auth]
* @property {Function} [createConnection]
* @property {number} [defaultPort]
* @property {number} [family]
* @property {object} [headers]
* @property {number} [hints]
* @property {string} [host]
* @property {string} [hostname]
* @property {boolean} [insecureHTTPParser]
* @property {string} [localAddress]
* @property {number} [localPort]
* @property {Function} [lookup]
* @property {number} [maxHeaderSize]
* @property {string} [method]
* @property {string} [path]
* @property {number} [port]
* @property {string} [protocol]
* @property {boolean} [setHost]
* @property {string} [socketPath]
* @property {number} [timeout]
* @property {AbortSignal} [signal]
* @property {httpAgent.Agent | boolean} [agent] Controls Agent behavior.
* @property {string} [auth] Basic authentication ('user:password') to compute an Authorization header.
* @property {Function} [createConnection] Produces a socket/stream to use when the agent option is not used.
* @property {number} [defaultPort] Default port for the protocol.
* @property {number} [family] IP address family to use when resolving host or hostname.
* @property {object} [headers] An object containing request headers.
* @property {number} [hints] Optional dns.lookup() hints.
* @property {string} [host] A domain name or IP address of the server to issue the request to.
* @property {string} [hostname] Alias for host.
* @property {boolean} [insecureHTTPParser] Use an insecure HTTP parser that accepts invalid HTTP headers when true.
* @property {string} [localAddress] Local interface to bind for network connections.
* @property {number} [localPort] Local port to connect from.
* @property {Function} [lookup] Custom lookup function. Default: dns.lookup().
* @property {number} [maxHeaderSize] Overrides the --max-http-header-size value for responses received from the server.
* @property {string} [method] A string specifying the HTTP request method.
* @property {string} [path] Request path.
* @property {number} [port] Port of remote server.
* @property {string} [protocol] Protocol to use.
* @property {boolean} [setHost] Specifies whether or not to automatically add the Host header.
* @property {AbortSignal} [signal] An AbortSignal that may be used to abort an ongoing request.
* @property {string} [socketPath] Unix domain socket.
* @property {number} [timeout] A number specifying the socket timeout in milliseconds.
*/

/**
Expand Down
6 changes: 3 additions & 3 deletions lib/internal/modules/esm/fetch_module.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ const { once } = require('events');
const { compose } = require('stream');
/**
* @typedef CacheEntry
* @property {Promise<string> | string} resolvedHREF
* @property {Record<string, string>} headers
* @property {Promise<Buffer> | Buffer} body
* @property {Promise<string> | string} resolvedHREF Parsed HREF of the request.
* @property {Record<string, string>} headers HTTP headers of the response.
* @property {Promise<Buffer> | Buffer} body Response body.
*/

/**
Expand Down
14 changes: 7 additions & 7 deletions lib/internal/modules/esm/loader.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ const { getOptionValue } = require('internal/options');

/**
* @typedef {object} ExportedHooks
* @property {Function} globalPreload
* @property {Function} resolve
* @property {Function} load
* @property {Function} globalPreload Global preload hook.
* @property {Function} resolve Resolve hook.
* @property {Function} load Load hook.
*/

/**
Expand All @@ -69,14 +69,14 @@ const { getOptionValue } = require('internal/options');

/**
* @typedef {object} KeyedExports
* @property {ModuleExports} exports
* @property {URL['href']} url
* @property {ModuleExports} exports The contents of the module.
* @property {URL['href']} url The URL of the module.
*/

/**
* @typedef {object} KeyedHook
* @property {Function} fn
* @property {URL['href']} url
* @property {Function} fn The hook function.
* @property {URL['href']} url The URL of the module.
*/

/**
Expand Down