mirror of
https://github.com/jprichardson/node-fs-extra.git
synced 2026-01-18 16:13:55 +00:00
* improve docs * Update docs/ensureSymlink-sync.md Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com> * Update docs/ensureSymlink.md Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com> * add Error type to docs Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
1.7 KiB
1.7 KiB
copySync(src, dest[, options])
Copy a file or directory. The directory can have contents.
src<String>Note that ifsrcis a directory it will copy everything inside of this directory, not the entire directory itself (see issue #537).dest<String>Note that ifsrcis a file,destcannot be a directory (see issue #323).options<Object>overwrite<boolean>: overwrite existing file or directory, default istrue. Note that the copy operation will silently fail if you set this tofalseand the destination exists. Use theerrorOnExistoption to change this behavior.errorOnExist<boolean>: whenoverwriteisfalseand the destination exists, throw an error. Default isfalse.dereference<boolean>: dereference symlinks, default isfalse.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 isfalse.filter<Function>: Function to filter copied files. Returntrueto include,falseto exclude.
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 })