mv

What is mv?

The 'mv' npm package is used for moving files and directories in Node.js. It provides a simple API to move files and directories, with options to overwrite existing files and create directories if they do not exist.

What are mv's main functionalities?

Move a file

This feature allows you to move a file from one location to another. The code sample demonstrates moving 'source.txt' to 'destination.txt'.

const mv = require('mv');

mv('source.txt', 'destination.txt', function(err) {
  if (err) throw err;
  console.log('File moved successfully');
});

Move a directory

This feature allows you to move a directory from one location to another. The 'mkdirp' option ensures that the destination directory is created if it does not exist.

const mv = require('mv');

mv('sourceDir', 'destinationDir', {mkdirp: true}, function(err) {
  if (err) throw err;
  console.log('Directory moved successfully');
});

Overwrite existing files

This feature allows you to overwrite existing files at the destination. The 'clobber' option is set to true to enable overwriting.

const mv = require('mv');

mv('source.txt', 'destination.txt', {clobber: true}, function(err) {
  if (err) throw err;
  console.log('File moved and overwritten successfully');
});

Other packages similar to mv

fs-extra

The 'fs-extra' package extends the native Node.js 'fs' module with additional methods, including methods for moving files and directories. It provides a more comprehensive set of file system utilities compared to 'mv'.

shelljs

The 'shelljs' package provides Unix shell commands for Node.js, including the 'mv' command for moving files and directories. It offers a broader range of shell commands, making it more versatile for scripting tasks.

node-fs

The 'node-fs' package is an extension of the native 'fs' module, providing additional file system methods, including moving files and directories. It is similar to 'fs-extra' but with a different set of additional features.

README

Usage:

var mv = require('mv');

mv('source/file', 'dest/file', function(err) {
  // done. it tried fs.rename first, and then falls back to
  // piping the source file to the dest file and then unlinking
  // the source file.
});

Another example:

mv('source/dir', 'dest/a/b/c/dir', {mkdirp: true}, function(err) {
  // done. it first created all the necessary directories, and then
  // tried fs.rename, then falls back to using ncp to copy the dir
  // to dest and then rimraf to remove the source dir
});

Another example:

mv('source/file', 'dest/file', {clobber: false}, function(err) {
  // done. If 'dest/file' exists, an error is returned
  // with err.code === 'EEXIST'.
});