Skip to content

Commit 9d6af61

Browse files
fossamagnatargos
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 <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
1 parent e874508 commit 9d6af61

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
@@ -977,6 +977,9 @@ changes:
977977
* `filter` {Function} Function to filter copied files/directories. Return
978978
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
979979
that resolves to `true` or `false` **Default:** `undefined`.
980+
* `src` {string} source path to copy.
981+
* `dest` {string} destination path to copy to.
982+
* Returns: {boolean|Promise}
980983
* `force` {boolean} overwrite existing file or directory. The copy
981984
operation will ignore errors if you set this to false and the destination
982985
exists. Use the `errorOnExist` option to change this behavior.
@@ -2282,6 +2285,9 @@ changes:
22822285
* `filter` {Function} Function to filter copied files/directories. Return
22832286
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
22842287
that resolves to `true` or `false` **Default:** `undefined`.
2288+
* `src` {string} source path to copy.
2289+
* `dest` {string} destination path to copy to.
2290+
* Returns: {boolean|Promise}
22852291
* `force` {boolean} overwrite existing file or directory. The copy
22862292
operation will ignore errors if you set this to false and the destination
22872293
exists. Use the `errorOnExist` option to change this behavior.
@@ -5107,6 +5113,9 @@ changes:
51075113
exists, throw an error. **Default:** `false`.
51085114
* `filter` {Function} Function to filter copied files/directories. Return
51095115
`true` to copy the item, `false` to ignore it. **Default:** `undefined`
5116+
* `src` {string} source path to copy.
5117+
* `dest` {string} destination path to copy to.
5118+
* Returns: {boolean}
51105119
* `force` {boolean} overwrite existing file or directory. The copy
51115120
operation will ignore errors if you set this to false and the destination
51125121
exists. Use the `errorOnExist` option to change this behavior.

0 commit comments

Comments
 (0)