copy-concurrently
Advanced tools
Promises of copies of files, directories and symlinks, with concurrency controls and win32 junction fallback.
The 'copy-concurrently' npm package is designed to copy files and directories concurrently, which can significantly speed up the copying process. It handles various edge cases and ensures that the copying process is efficient and reliable.
Basic File Copy
This feature allows you to copy a single file from a source path to a destination path. The code sample demonstrates how to copy 'source.txt' to 'destination.txt' and handle success or error cases.
const copy = require('copy-concurrently');
copy('source.txt', 'destination.txt')
.then(() => console.log('File copied successfully!'))
.catch(err => console.error('Error copying file:', err));Directory Copy
This feature allows you to copy an entire directory from a source path to a destination path. The code sample demonstrates how to copy 'sourceDir' to 'destinationDir' and handle success or error cases.
const copy = require('copy-concurrently');
copy('sourceDir', 'destinationDir')
.then(() => console.log('Directory copied successfully!'))
.catch(err => console.error('Error copying directory:', err));Overwrite Existing Files
This feature allows you to overwrite existing files at the destination path. The code sample demonstrates how to copy 'source.txt' to 'destination.txt' with the overwrite option enabled.
const copy = require('copy-concurrently');
copy('source.txt', 'destination.txt', { overwrite: true })
.then(() => console.log('File copied and overwritten successfully!'))
.catch(err => console.error('Error copying file:', err));Error Handling
This feature provides robust error handling during the copy process. The code sample demonstrates how to handle specific errors, such as a missing source file, and log appropriate error messages.
const copy = require('copy-concurrently');
copy('source.txt', 'destination.txt')
.then(() => console.log('File copied successfully!'))
.catch(err => {
if (err.code === 'ENOENT') {
console.error('Source file not found!');
} else {
console.error('Error copying file:', err);
}
});'fs-extra' is a popular package that extends the native Node.js 'fs' module with additional methods, including file and directory copying. It provides similar functionality to 'copy-concurrently' but also includes a wide range of other file system operations, making it a more versatile choice for general file system manipulation.
'ncp' (Node Copy) is another package that provides asynchronous copying of files and directories. It offers similar functionality to 'copy-concurrently' but is less focused on concurrency and more on simplicity and ease of use. 'ncp' is a good choice for straightforward copy operations without the need for advanced concurrency features.
'cpy' is a package that provides a simple and fast way to copy files. It supports glob patterns and allows for advanced options like filtering and renaming files during the copy process. 'cpy' is similar to 'copy-concurrently' in terms of performance but offers more flexibility in terms of file selection and manipulation.
Copy files, directories and symlinks
const copy = require('copy-concurrently')
copy('/path/to/thing', '/new/path/thing').then(() => {
// this is now copied
}).catch(err => {
// oh noooo
})
Copies files, directories and symlinks. Ownership is maintained when running as root, permissions are always maintained. On Windows, if symlinks are unavailable then junctions will be used.
Recursively copies from to to and resolves its promise when finished.
If to already exists then the promise will be rejected with an EEXIST
error.
Options are:
1) The maximum number of concurrent copies to do at once.copy.item) The function to call on each file after recursing into a directory.process.platform === 'win32') If true enables Windows symlink semantics. This requires
an extra stat to determine if the destination of a symlink is a file or directory. If symlinking a directory
fails then we'll try making a junction instead.Options can also include dependency injection:
global.Promise) The promise implementation to use, defaults to Node's.require('fs')) The filesystem module to use. Can be used
to use graceful-fs or to inject a mock.require('fs-write-stream-atomic')) The
implementation of writeStreamAtomic to use. Used to inject a mock.process.getuid) A function that returns the current UID. Used to inject a mock.Ordinarily you'd only call copy above. But it's possible to use it's
component functions directly. This is useful if, say, you're writing
move-concurently.
Copies an ordinary file from to destination to. Uses
fs-write-stream-atomic to ensure that the file is either entirely copied
or not at all.
Options are:
getuid() is 0 then this and gid will be used to
set the user and group of to. If uid is present then gid must be too.to will have its perms set to mode.require('fs')) The filesystem module to use. Can be used
to use graceful-fs or to inject a mock.global.Promise) The promise implementation to use, defaults to Node's.require('fs-write-stream-atomic')) The
implementation of writeStreamAtomic to use. Used to inject a mock.Copies a symlink from to destination to. If you're using Windows and
symlinking fails and what you're linking is a directory then junctions will
be tried instead.
Options are:
require('fs')) The filesystem module to use. Can be used
to use graceful-fs or to inject a mock.global.Promise) The promise implementation to use, defaults to Node's.process.platform === 'win32') If true enables Windows symlink semantics. This requires
an extra stat to determine if the destination of a symlink is a file or directory. If symlinking a directory
fails then we'll try making a junction instead.Reads all of the files in directory from and adds them to the queue
using recurseWith (by default copy.item).
Options are:
run-queue object to add files found inside from to.copy.item) The function to call on each file after recursing into a directory.getuid() is 0 then this and gid will be used to
set the user and group of to. If uid is present then gid must be too.to will have its perms set to mode.require('fs')) The filesystem module to use. Can be used
to use graceful-fs or to inject a mock.process.getuid) A function that returns the current UID. Used to inject a mock.Copies some kind of from to destination to. This looks at the filetype
and calls copy.file, copy.symlink or copy.recurse as appropriate.
Symlink copies are queued with a priority such that they happen after all file and directory copies as you can't create a junction on windows to a file that doesn't exist yet.
Options are:
run-queue object to
pass to copy.recurse if from is a directory.copy.item) The function to call on each file after recursing into a directory.getuid() is 0 then this and gid will be used to
set the user and group of to. If uid is present then gid must be too.to will have its perms set to mode.require('fs')) The filesystem module to use. Can be used
to use graceful-fs or to inject a mock.process.getuid) A function that returns the current UID. Used to inject a mock.process.platform === 'win32') If true enables Windows symlink semantics. This requires
an extra stat to determine if the destination of a symlink is a file or directory. If symlinking a directory
fails then we'll try making a junction instead.global.Promise) The promise implementation to use, defaults to Node's.require('fs-write-stream-atomic')) The
implementation of writeStreamAtomic to use. Used to inject a mock.FAQs
Promises of copies of files, directories and symlinks, with concurrency controls and win32 junction fallback.
The npm package copy-concurrently receives a total of 3,416,460 weekly downloads. As such, copy-concurrently popularity was classified as popular.
We found that copy-concurrently demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.