Move a file - Even works across devices
Switch branches/tags
Clone or download
Latest commit 3a72d20 Dec 15, 2017
Permalink
Failed to load latest commit information.
test Simplify Nov 3, 2017
.editorconfig Init Nov 3, 2017
.gitattributes Init Nov 3, 2017
.gitignore Init Nov 3, 2017
.npmrc Init Nov 3, 2017
.travis.yml Init Nov 3, 2017
index.js Simplify Nov 3, 2017
license Init Nov 3, 2017
package.json 1.0.0 Dec 15, 2017
readme.md Init Nov 3, 2017

readme.md

move-file Build Status

Move a file

The built-in fs.rename() is just a JavaScript wrapper for the C rename(2) function, which doesn't support moving files across partitions or devices. This module is what you would have expected fs.rename() to be.

Highlights

  • Promise API.
  • Supports moving a file across partitions and devices.
  • Optionally prevent overwriting an existing file.
  • Creates non-existent destination directories for you.

Install

$ npm install move-file

Usage

const moveFile = require('move-file');

(async () => {
	await moveFile('source/unicorn.png', 'destination/unicorn.png');
	console.log('File moved');
})();

API

moveFile(source, destination, [options])

Returns a Promise.

moveFile.sync(source, destination, [options])

source

Type: string

File you want to move.

destination

Type: string

Where you want the file moved.

options

Type: Object

overwrite

Type: boolean
Default: true

Overwrite existing destination file.

Related

  • cp-file - Copy a file
  • cpy - Copy files
  • make-dir - Make a directory and its parents if needed

License

MIT © Sindre Sorhus