Refactor to more specific function types #5363
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This refactoring makes abstract function types more specific, such as just `Function`. I believe this will help code changes for ESM. A part of #4496
ybiquitous
commented
Jun 8, 2021
| @@ -24,11 +26,11 @@ function isContainerNode(node) { | |||
| * executes a provided function once for each declaration block. | |||
| * | |||
| * @param {Root | Document} root - root element of file. | |||
| * @param {function} cb - Function to execute for each declaration block | |||
There was a problem hiding this comment.
[note] The name cb seems a bit confusing to me.
| * @returns {void} | ||
| */ | ||
| module.exports = function (options, callback) { | ||
| module.exports = function checkAgainstRule(options, callback) { |
There was a problem hiding this comment.
[note] Naming a function seems good to me for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A part of #4496
This refactoring makes abstract function types more specific, such as just
Function.I believe this will help code changes for ESM.
Note:
lib/utils/validateOptions.js.https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html