update copy*() docs to include checkPathsBeforeCopying

jprichardson · Apr 1, 2019 · 30a1dea · 30a1dea
1 parent 3d24bbf
commit 30a1dea
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/copy-sync.md b/docs/copy-sync.md
@@ -7,6 +7,7 @@ Copy a file or directory. The directory can have contents. Like `cp -r`.
 - `options` `<Object>`
   - `overwrite` `<boolean>`: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior.
   - `errorOnExist` `<boolean>`: when `overwrite` is `false` and the destination exists, throw an error. Default is `false`.
+  - `checkPathsBeforeCopying` `<boolean>`: check `src` and `dest` paths before copying. Default is `true`.
   - `dereference` `<boolean>`: dereference symlinks, default is `false`.
   - `preserveTimestamps` `<boolean>`: When true, will set last modification and access times to the ones of the original source files. When false, timestamp behavior is OS-dependent. Default is `false`.
   - `filter` `<Function>`: Function to filter copied files. Return `true` to include, `false` to exclude.

diff --git a/docs/copy.md b/docs/copy.md
@@ -7,6 +7,7 @@ Copy a file or directory. The directory can have contents. Like `cp -r`.
 - `options` `<Object>`
   - `overwrite` `<boolean>`: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior.
   - `errorOnExist` `<boolean>`: when `overwrite` is `false` and the destination exists, throw an error. Default is `false`.
+  - `checkPathsBeforeCopying` `<boolean>`: check `src` and `dest` paths before copying. Default is `true`.
   - `dereference` `<boolean>`: dereference symlinks, default is `false`.
   - `preserveTimestamps` `<boolean>`: When true, will set last modification and access times to the ones of the original source files. When false, timestamp behavior is OS-dependent. Default is `false`.
   - `filter` `<Function>`: Function to filter copied files. Return `true` to include, `false` to exclude. Can also return a `Promise` that resolves to `true` or `false` (or pass in an `async` function).