Skip to content

Commit b5ad92f

Browse files
fossamagnadanielleadams
authored andcommitted
doc: add args of filter option of fs.cp
add the describe arguments and return value about filter function option of fs.cp PR-URL: #45739 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 1284789 commit b5ad92f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/api/fs.md

+9
Original file line numberDiff line numberDiff line change
@@ -971,6 +971,9 @@ changes:
971971
* `filter` {Function} Function to filter copied files/directories. Return
972972
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
973973
that resolves to `true` or `false` **Default:** `undefined`.
974+
* `src` {string} source path to copy.
975+
* `dest` {string} destination path to copy to.
976+
* Returns: {boolean|Promise}
974977
* `force` {boolean} overwrite existing file or directory. The copy
975978
operation will ignore errors if you set this to false and the destination
976979
exists. Use the `errorOnExist` option to change this behavior.
@@ -2265,6 +2268,9 @@ changes:
22652268
* `filter` {Function} Function to filter copied files/directories. Return
22662269
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
22672270
that resolves to `true` or `false` **Default:** `undefined`.
2271+
* `src` {string} source path to copy.
2272+
* `dest` {string} destination path to copy to.
2273+
* Returns: {boolean|Promise}
22682274
* `force` {boolean} overwrite existing file or directory. The copy
22692275
operation will ignore errors if you set this to false and the destination
22702276
exists. Use the `errorOnExist` option to change this behavior.
@@ -5077,6 +5083,9 @@ changes:
50775083
exists, throw an error. **Default:** `false`.
50785084
* `filter` {Function} Function to filter copied files/directories. Return
50795085
`true` to copy the item, `false` to ignore it. **Default:** `undefined`
5086+
* `src` {string} source path to copy.
5087+
* `dest` {string} destination path to copy to.
5088+
* Returns: {boolean}
50805089
* `force` {boolean} overwrite existing file or directory. The copy
50815090
operation will ignore errors if you set this to false and the destination
50825091
exists. Use the `errorOnExist` option to change this behavior.

0 commit comments

Comments
 (0)