From b5ad92fea27de35427b465d73f968e673ae174ce Mon Sep 17 00:00:00 2001 From: MURAKAMI Masahiko Date: Fri, 9 Dec 2022 18:00:26 +0900 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/45739 Reviewed-By: Luigi Pinca Reviewed-By: Antoine du Hamel --- doc/api/fs.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index e4dbd8b61f9500..fbec52cbf1ef47 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -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. @@ -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. @@ -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.