8000 GitHub - sindresorhus/move-file at v1.2.0
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

sindresorhus/move-file

Repository files navigation

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('The file has been moved');
})();

API

moveFile(source, destination, [options])

Returns a Promise that resolves when the file has been moved.

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

About

Move a file - Even works across devices

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  
0