Skip to content

Commit

Permalink
doc: update options.filter description for fs.cp
Browse files Browse the repository at this point in the history
PR-URL: #49289
Fixes: #49092
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
  • Loading branch information
shubham9411 authored and targos committed Nov 26, 2023
1 parent d4f26f4 commit 0dda724
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -991,7 +991,8 @@ changes:
* `errorOnExist` {boolean} when `force` is `false`, and the destination
exists, throw an error. **Default:** `false`.
* `filter` {Function} Function to filter copied files/directories. Return
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
`true` to copy the item, `false` to ignore it. When ignoring a directory,
all of its contents will be skipped as well. 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.
Expand Down Expand Up @@ -2322,7 +2323,8 @@ changes:
* `errorOnExist` {boolean} when `force` is `false`, and the destination
exists, throw an error. **Default:** `false`.
* `filter` {Function} Function to filter copied files/directories. Return
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
`true` to copy the item, `false` to ignore it. When ignoring a directory,
all of its contents will be skipped as well. 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.
Expand Down Expand Up @@ -5190,7 +5192,8 @@ changes:
* `errorOnExist` {boolean} when `force` is `false`, and the destination
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`
`true` to copy the item, `false` to ignore it. When ignoring a directory,
all of its contents will be skipped as well. **Default:** `undefined`
* `src` {string} source path to copy.
* `dest` {string} destination path to copy to.
* Returns: {boolean}
Expand Down

0 comments on commit 0dda724

Please sign in to comment.