From 621f63ec7ada3f0d86a7ec12585a3bdd6e791885 Mon Sep 17 00:00:00 2001
From: MURAKAMI Masahiko <fossamagna2@gmail.com>
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 <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
---
 doc/api/fs.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index 4d7362a7f2c98f..d3d4e2bd389eeb 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -977,6 +977,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.
@@ -2282,6 +2285,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.
@@ -5107,6 +5113,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.