Commit 0dda724
doc: update options.filter description for fs.cp
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>1 parent d4f26f4 commit 0dda724
1 file changed
Lines changed: 6 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -991,7 +991,8 @@ changes: | |||
| 991 | 991 | * `errorOnExist` {boolean} when `force` is `false`, and the destination | |
| 992 | 992 | exists, throw an error. **Default:** `false`. | |
| 993 | 993 | * `filter` {Function} Function to filter copied files/directories. Return | |
| 994 | - `true` to copy the item, `false` to ignore it. Can also return a `Promise` | ||
| 994 | + `true` to copy the item, `false` to ignore it. When ignoring a directory, | ||
| 995 | + all of its contents will be skipped as well. Can also return a `Promise` | ||
| 995 | 996 | that resolves to `true` or `false` **Default:** `undefined`. | |
| 996 | 997 | * `src` {string} source path to copy. | |
| 997 | 998 | * `dest` {string} destination path to copy to. | |
@@ -2322,7 +2323,8 @@ changes: | |||
| 2322 | 2323 | * `errorOnExist` {boolean} when `force` is `false`, and the destination | |
| 2323 | 2324 | exists, throw an error. **Default:** `false`. | |
| 2324 | 2325 | * `filter` {Function} Function to filter copied files/directories. Return | |
| 2325 | - `true` to copy the item, `false` to ignore it. Can also return a `Promise` | ||
| 2326 | + `true` to copy the item, `false` to ignore it. When ignoring a directory, | ||
| 2327 | + all of its contents will be skipped as well. Can also return a `Promise` | ||
| 2326 | 2328 | that resolves to `true` or `false` **Default:** `undefined`. | |
| 2327 | 2329 | * `src` {string} source path to copy. | |
| 2328 | 2330 | * `dest` {string} destination path to copy to. | |
@@ -5190,7 +5192,8 @@ changes: | |||
| 5190 | 5192 | * `errorOnExist` {boolean} when `force` is `false`, and the destination | |
| 5191 | 5193 | exists, throw an error. **Default:** `false`. | |
| 5192 | 5194 | * `filter` {Function} Function to filter copied files/directories. Return | |
| 5193 | - `true` to copy the item, `false` to ignore it. **Default:** `undefined` | ||
| 5195 | + `true` to copy the item, `false` to ignore it. When ignoring a directory, | ||
| 5196 | + all of its contents will be skipped as well. **Default:** `undefined` | ||
| 5194 | 5197 | * `src` {string} source path to copy. | |
| 5195 | 5198 | * `dest` {string} destination path to copy to. | |
| 5196 | 5199 | * Returns: {boolean} | |
0 commit comments