Skip to content

Commit

Permalink
doc: add args of filter option of fs.cp
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
fossamagna authored and danielleadams committed Dec 30, 2022
1 parent 9125fac commit 227ef28
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/api/fs.md
Expand Up @@ -971,6 +971,9 @@ changes:
* `filter` {Function} Function to filter copied files/directories. Return
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
that resolves to `true` or `false` **Default:** `undefined`.
* `src` {string} source path to copy.
* `dest` {string} destination path to copy to.
* Returns: {boolean|Promise}
* `force` {boolean} overwrite existing file or directory. The copy
operation will ignore errors if you set this to false and the destination
exists. Use the `errorOnExist` option to change this behavior.
Expand Down Expand Up @@ -2265,6 +2268,9 @@ changes:
* `filter` {Function} Function to filter copied files/directories. Return
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
that resolves to `true` or `false` **Default:** `undefined`.
* `src` {string} source path to copy.
* `dest` {string} destination path to copy to.
* Returns: {boolean|Promise}
* `force` {boolean} overwrite existing file or directory. The copy
operation will ignore errors if you set this to false and the destination
exists. Use the `errorOnExist` option to change this behavior.
Expand Down Expand Up @@ -5077,6 +5083,9 @@ changes:
exists, throw an error. **Default:** `false`.
* `filter` {Function} Function to filter copied files/directories. Return
`true` to copy the item, `false` to ignore it. **Default:** `undefined`
* `src` {string} source path to copy.
* `dest` {string} destination path to copy to.
* Returns: {boolean}
* `force` {boolean} overwrite existing file or directory. The copy
operation will ignore errors if you set this to false and the destination
exists. Use the `errorOnExist` option to change this behavior.
Expand Down

0 comments on commit 227ef28

Please sign in to comment.