sindresorhus / Move File
Licence: mit
Move a file - Even works across devices
Stars: ✭ 158
Programming Languages
javascript
184084 projects - #8 most used programming language
move-file
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
- move-file-cli - CLI for this module
- cp-file - Copy a file
- cpy - Copy files
- make-dir - Make a directory and its parents if needed
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].