From f920f925b22615237da0ce46eb2b5d69d495788a Mon Sep 17 00:00:00 2001 From: zhenweijin Date: Mon, 29 Apr 2024 11:16:52 +0800 Subject: [PATCH] doc: update the description of the return type for options.filter --- doc/api/fs.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index d6afc9d5ea9403..f37781483746ee 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1049,7 +1049,8 @@ changes: that resolves to `true` or `false` **Default:** `undefined`. * `src` {string} source path to copy. * `dest` {string} destination path to copy to. - * Returns: {boolean|Promise} + * Returns: {boolean|Promise} A value that is coercible to `boolean` or + a `Promise` that fulfils with such value. * `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. @@ -2455,7 +2456,8 @@ changes: that resolves to `true` or `false` **Default:** `undefined`. * `src` {string} source path to copy. * `dest` {string} destination path to copy to. - * Returns: {boolean|Promise} + * Returns: {boolean|Promise} A value that is coercible to `boolean` or + a `Promise` that fulfils with such value. * `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. @@ -5447,7 +5449,8 @@ changes: 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} + * Returns: {boolean} Any non-`Promise` value that is coercible + to `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.