Skip to content

Commit ac5be14

Browse files
kylo5abymarco-ippolito
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 <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
1 parent 8172412 commit ac5be14

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
@@ -1023,7 +1023,8 @@ changes:
10231023
that resolves to `true` or `false` **Default:** `undefined`.
10241024
* `src` {string} source path to copy.
10251025
* `dest` {string} destination path to copy to.
1026-
* Returns: {boolean|Promise}
1026+
* Returns: {boolean|Promise} A value that is coercible to `boolean` or
1027+
a `Promise` that fulfils with such value.
10271028
* `force` {boolean} overwrite existing file or directory. The copy
10281029
operation will ignore errors if you set this to false and the destination
10291030
exists. Use the `errorOnExist` option to change this behavior.
@@ -2386,7 +2387,8 @@ changes:
23862387
that resolves to `true` or `false` **Default:** `undefined`.
23872388
* `src` {string} source path to copy.
23882389
* `dest` {string} destination path to copy to.
2389-
* Returns: {boolean|Promise}
2390+
* Returns: {boolean|Promise} A value that is coercible to `boolean` or
2391+
a `Promise` that fulfils with such value.
23902392
* `force` {boolean} overwrite existing file or directory. The copy
23912393
operation will ignore errors if you set this to false and the destination
23922394
exists. Use the `errorOnExist` option to change this behavior.
@@ -5361,7 +5363,8 @@ changes:
53615363
all of its contents will be skipped as well. **Default:** `undefined`
53625364
* `src` {string} source path to copy.
53635365
* `dest` {string} destination path to copy to.
5364-
* Returns: {boolean}
5366+
* Returns: {boolean} Any non-`Promise` value that is coercible
5367+
to `boolean`.
53655368
* `force` {boolean} overwrite existing file or directory. The copy
53665369
operation will ignore errors if you set this to false and the destination
53675370
exists. Use the `errorOnExist` option to change this behavior.

0 commit comments

Comments
 (0)