copy-sync.md
1.43 KB
copySync(src, dest, [options])
Copy a file or directory. The directory can have contents. Like cp -r
.
-
src
<String>
-
dest
<String>
-
options
<Object>
-
overwrite
<boolean>
: overwrite existing file or directory, default istrue
. Note that the copy operation will silently fail if you set this tofalse
and the destination exists. Use theerrorOnExist
option to change this behavior. -
errorOnExist
<boolean>
: whenoverwrite
isfalse
and the destination exists, throw an error. Default isfalse
. -
dereference
<boolean>
: dereference symlinks, default isfalse
. -
preserveTimestamps
<boolean>
: will set last modification and access times to the ones of the original source files, default isfalse
. -
filter
<Function>
: Function to filter copied files. Returntrue
to include,false
to exclude. This can also be a RegExp, however this is deprecated (See issue #239 for background).
-
Example:
const fs = require('fs-extra')
// copy file
fs.copySync('/tmp/myfile', '/tmp/mynewfile')
// copy directory, even if it has subdirectories or files
fs.copySync('/tmp/mydir', '/tmp/mynewdir')
Using filter function
const fs = require('fs-extra')
const filterFunc = (src, dest) => {
// your logic here
// it will be copied if return true
}
fs.copySync('/tmp/mydir', '/tmp/mynewdir', { filter: filterFunc })