Skip to content

Commit befabe5

Browse files
kylo5abytargos
authored andcommitted
doc: update the description of the return type for options.filter
PR-URL: #52742 Refs: #52461 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent d1c10fe commit befabe5

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/api/fs.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1050,7 +1050,8 @@ changes:
10501050
that resolves to `true` or `false` **Default:** `undefined`.
10511051
* `src` {string} source path to copy.
10521052
* `dest` {string} destination path to copy to.
1053-
* Returns: {boolean|Promise}
1053+
* Returns: {boolean|Promise} A value that is coercible to `boolean` or
1054+
a `Promise` that fulfils with such value.
10541055
* `force` {boolean} overwrite existing file or directory. The copy
10551056
operation will ignore errors if you set this to false and the destination
10561057
exists. Use the `errorOnExist` option to change this behavior.
@@ -2464,7 +2465,8 @@ changes:
24642465
that resolves to `true` or `false` **Default:** `undefined`.
24652466
* `src` {string} source path to copy.
24662467
* `dest` {string} destination path to copy to.
2467-
* Returns: {boolean|Promise}
2468+
* Returns: {boolean|Promise} A value that is coercible to `boolean` or
2469+
a `Promise` that fulfils with such value.
24682470
* `force` {boolean} overwrite existing file or directory. The copy
24692471
operation will ignore errors if you set this to false and the destination
24702472
exists. Use the `errorOnExist` option to change this behavior.
@@ -5498,7 +5500,8 @@ changes:
54985500
all of its contents will be skipped as well. **Default:** `undefined`
54995501
* `src` {string} source path to copy.
55005502
* `dest` {string} destination path to copy to.
5501-
* Returns: {boolean}
5503+
* Returns: {boolean} Any non-`Promise` value that is coercible
5504+
to `boolean`.
55025505
* `force` {boolean} overwrite existing file or directory. The copy
55035506
operation will ignore errors if you set this to false and the destination
55045507
exists. Use the `errorOnExist` option to change this behavior.

0 commit comments

Comments
 (0)