summaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/copy.md
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 23:08:57 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 23:08:57 +0300
commit726b81b19251674e149ccfbb1abacbd837fc6db0 (patch)
treefbdbb227dc01357eb76e8222d76185bc124c5ca6 /node_modules/fs-extra/docs/copy.md
parent34f0890e175698940d49238097579f44e4d78c89 (diff)
downloadFlashRunner-726b81b19251674e149ccfbb1abacbd837fc6db0.tar.gz
FlashRunner-726b81b19251674e149ccfbb1abacbd837fc6db0.tar.zst
Removed files that should not have been included in git
Diffstat (limited to 'node_modules/fs-extra/docs/copy.md')
-rw-r--r--node_modules/fs-extra/docs/copy.md57
1 files changed, 0 insertions, 57 deletions
diff --git a/node_modules/fs-extra/docs/copy.md b/node_modules/fs-extra/docs/copy.md
deleted file mode 100644
index 8440726..0000000
--- a/node_modules/fs-extra/docs/copy.md
+++ /dev/null
@@ -1,57 +0,0 @@
-# copy(src, dest, [options, callback])
-
-Copy a file or directory. The directory can have contents. Like `cp -r`.
-
-- `src` `<String>`
-- `dest` `<String>` Note that if `src` is a file, `dest` cannot be a directory (see [issue #323](https://github.com/jprichardson/node-fs-extra/issues/323)).
-- `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`.
- - `dereference` `<boolean>`: dereference symlinks, default is `false`.
- - `preserveTimestamps` `<boolean>`: will set last modification and access times to the ones of the original source files, default is `false`.
- - `filter` `<Function>`: Function to filter copied files. Return `true` to include, `false` to exclude. This can also be a RegExp, however this is deprecated (See [issue #239](https://github.com/jprichardson/node-fs-extra/issues/239) for background).
-- `callback` `<Function>`
-
-## Example:
-
-```js
-const fs = require('fs-extra')
-
-fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
- if (err) return console.error(err)
-
- console.log('success!')
-}) // copies file
-
-fs.copy('/tmp/mydir', '/tmp/mynewdir', err => {
- if (err) return console.error(err)
-
- console.log('success!')
-}) // copies directory, even if it has subdirectories or files
-
-// Promise usage:
-fs.copy('/tmp/myfile', '/tmp/mynewfile')
-.then(() => {
- console.log('success!')
-})
-.catch(err => {
- console.error(err)
-})
-```
-
-**Using filter function**
-
-```js
-const fs = require('fs-extra')
-
-const filterFunc = (src, dest) => {
- // your logic here
- // it will be copied if return true
-}
-
-fs.copy('/tmp/mydir', '/tmp/mynewdir', { filter: filterFunc }, err => {
- if (err) return console.error(err)
-
- console.log('success!')
-})
-```