fs: ensure return value type of options.filter in cpSync consistent with doc
#52461
Conversation
This file contains hidden or 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
nodejs-github-bot
added
fs
lpinca
approved these changes
Apr 13, 2024
|
Can you add a test? |
github-actions
bot
removed
the
request-ci
Hi, I have added related test |
targos
reviewed
Apr 24, 2024
Comment on lines
-67
to
+66
| if (isPromise(shouldCopy)) { | ||
| if (typeof shouldCopy !== 'boolean') { |
There was a problem hiding this comment.
I have the feeling this was done on purpose, to support truthy values, and there's a Promise check to prevent mistakes.
There was a problem hiding this comment.
Thanks for your feedback. and I have a question, for
opt.filter = (value) => {
//
}its return type contradicts the documentation, which states Returns: <boolean>, but it wont throw an error. Should here use a more precise description, such as the type that is coercible to boolean type?
There was a problem hiding this comment.
I'm fine with either (changing the code or the docs); if we change the code, let's land this as semver-major.
There was a problem hiding this comment.
I think I might prefer changing the docs to changing the code here.
aduh95
added
the
semver-major
aduh95
approved these changes
Apr 24, 2024
|
Closed in favor of #52742. |
nodejs-github-bot
pushed a commit
that referenced
this pull request
Jun 19, 2024
PR-URL: #52742 Refs: #52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
targos
pushed a commit
that referenced
this pull request
Jun 20, 2024
PR-URL: #52742 Refs: #52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
sophoniie
pushed a commit
to sophoniie/node
that referenced
this pull request
Jun 20, 2024
PR-URL: nodejs#52742 Refs: nodejs#52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
bmeck
pushed a commit
to bmeck/node
that referenced
this pull request
Jun 22, 2024
PR-URL: nodejs#52742 Refs: nodejs#52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
marco-ippolito
pushed a commit
that referenced
this pull request
Jul 19, 2024
PR-URL: #52742 Refs: #52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
marco-ippolito
pushed a commit
that referenced
this pull request
Jul 19, 2024
PR-URL: #52742 Refs: #52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
Ensure return type of options.filter in cpsync matches doc.
according to the documentation, the return value of
options.filterhasbooleantype.