Skip to content

Commit fe18438

Browse files
shubham9411pull[bot]
authored andcommitted
doc: update options.filter description for fs.cp
PR-URL: #49289 Fixes: #49092 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: LiviaMedeiros <[email protected]>
1 parent a185af6 commit fe18438

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
@@ -1001,7 +1001,8 @@ changes:
10011001
* `errorOnExist` {boolean} when `force` is `false`, and the destination
10021002
exists, throw an error. **Default:** `false`.
10031003
* `filter` {Function} Function to filter copied files/directories. Return
1004-
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
1004+
`true` to copy the item, `false` to ignore it. When ignoring a directory,
1005+
all of its contents will be skipped as well. Can also return a `Promise`
10051006
that resolves to `true` or `false` **Default:** `undefined`.
10061007
* `src` {string} source path to copy.
10071008
* `dest` {string} destination path to copy to.
@@ -2351,7 +2352,8 @@ changes:
23512352
* `errorOnExist` {boolean} when `force` is `false`, and the destination
23522353
exists, throw an error. **Default:** `false`.
23532354
* `filter` {Function} Function to filter copied files/directories. Return
2354-
`true` to copy the item, `false` to ignore it. Can also return a `Promise`
2355+
`true` to copy the item, `false` to ignore it. When ignoring a directory,
2356+
all of its contents will be skipped as well. Can also return a `Promise`
23552357
that resolves to `true` or `false` **Default:** `undefined`.
23562358
* `src` {string} source path to copy.
23572359
* `dest` {string} destination path to copy to.
@@ -5278,7 +5280,8 @@ changes:
52785280
* `errorOnExist` {boolean} when `force` is `false`, and the destination
52795281
exists, throw an error. **Default:** `false`.
52805282
* `filter` {Function} Function to filter copied files/directories. Return
5281-
`true` to copy the item, `false` to ignore it. **Default:** `undefined`
5283+
`true` to copy the item, `false` to ignore it. When ignoring a directory,
5284+
all of its contents will be skipped as well. **Default:** `undefined`
52825285
* `src` {string} source path to copy.
52835286
* `dest` {string} destination path to copy to.
52845287
* Returns: {boolean}

0 commit comments

Comments
 (0)