Skip to content

doc: add correct argument types for fs.cp APIs #58627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: add correct argument types for fs.cp APIs #58627

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1048,8 +1048,8 @@ changes:
whether to perform path resolution for symlinks.
-->

* `src` {string|URL} source path to copy.
* `dest` {string|URL} destination path to copy to.
* `src` {string|URL|Buffer} source path to copy.
* `dest` {string|URL|Buffer} destination path to copy to.
* `options` {Object}
* `dereference` {boolean} dereference symlinks. **Default:** `false`.
* `errorOnExist` {boolean} when `force` is `false`, and the destination
Expand All @@ -1058,8 +1058,8 @@ changes:
`true` to copy the item, `false` to ignore it. When ignoring a directory,
all of its contents will be skipped as well. 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.
* `src` {string|URL|Buffer} source path to copy.
* `dest` {string|URL|Buffer} destination path to copy to.
* 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
Expand Down Expand Up @@ -2479,8 +2479,8 @@ changes:
whether to perform path resolution for symlinks.
-->

* `src` {string|URL} source path to copy.
* `dest` {string|URL} destination path to copy to.
* `src` {string|URL|Buffer} source path to copy.
* `dest` {string|URL|Buffer} destination path to copy to.
* `options` {Object}
* `dereference` {boolean} dereference symlinks. **Default:** `false`.
* `errorOnExist` {boolean} when `force` is `false`, and the destination
Expand All @@ -2489,8 +2489,8 @@ changes:
`true` to copy the item, `false` to ignore it. When ignoring a directory,
all of its contents will be skipped as well. 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.
* `src` {string|URL|Buffer} source path to copy.
* `dest` {string|URL|Buffer} destination path to copy to.
* 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
Expand Down Expand Up @@ -5535,17 +5535,17 @@ changes:
whether to perform path resolution for symlinks.
-->

* `src` {string|URL} source path to copy.
* `dest` {string|URL} destination path to copy to.
* `src` {string|URL|Buffer} source path to copy.
* `dest` {string|URL|Buffer} destination path to copy to.
* `options` {Object}
* `dereference` {boolean} dereference symlinks. **Default:** `false`.
* `errorOnExist` {boolean} when `force` is `false`, and the destination
exists, throw an error. **Default:** `false`.
* `filter` {Function} Function to filter copied files/directories. Return
`true` to copy the item, `false` to ignore it. When ignoring a directory,
all of its contents will be skipped as well. **Default:** `undefined`
* `src` {string} source path to copy.
* `dest` {string} destination path to copy to.
* `src` {string|URL|Buffer} source path to copy.
* `dest` {string|URL|Buffer} destination path to copy to.
* Returns: {boolean} Any non-`Promise` value that is coercible
to `boolean`.
* `force` {boolean} overwrite existing file or directory. The copy
Expand Down
Loading