doc: update the description of the return type for options.filter #52742
+6
−3
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
nodejs-github-bot
added
doc
aduh95
reviewed
Apr 30, 2024
doc/api/fs.md
Outdated
| @@ -1049,7 +1049,7 @@ changes: | |||
| that resolves to `true` or `false` **Default:** `undefined`. | |||
| * `src` {string} source path to copy. | |||
| * `dest` {string} destination path to copy to. | |||
| * Returns: {boolean|Promise} | |||
| * Returns: `Promise` or the type that is coercible to `boolean`. | |||
There was a problem hiding this comment.
Suggested change
| * Returns: `Promise` or the type that is coercible to `boolean`. | |
| * Returns: {boolean|Promise} A value that is coercible to `boolean` or a `Promise` that fulfils with such value. |
aduh95
reviewed
Apr 30, 2024
doc/api/fs.md
Outdated
| @@ -5447,7 +5447,7 @@ changes: | |||
| all of its contents will be skipped as well. **Default:** `undefined` | |||
| * `src` {string} source path to copy. | |||
| * `dest` {string} destination path to copy to. | |||
| * Returns: {boolean} | |||
| * Returns: the type that is coercible to `boolean`. | |||
There was a problem hiding this comment.
Suggested change
| * Returns: the type that is coercible to `boolean`. | |
| * Returns: {boolean} Any non-`Promise` value that is coercible to `boolean`. |
|
can you please take a look @aduh95 |
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.
The return type of
options.filterinfs.cp,fs.cpSync, andfsPromises.cpcan be coerced to types that are coercible toboolean, not onlyboolean, So I update related contents in the doc.Once this PR has no further issues, I will close #52461.
Refs: #52461