mirror of
https://github.com/jprichardson/node-fs-extra.git
synced 2025-12-08 20:36:18 +00:00
* Clarify docs for copy*() filter Fixes #843 * Implement suggestion https://github.com/jprichardson/node-fs-extra/pull/884#discussion_r608216178
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/directories. Returntrueto copy the item,falseto ignore it.
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 })