JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 428063
  • Score
    100M100P100Q163178F
  • License MIT

Move a file - Even works across devices

Package Exports

  • move-file
  • move-file/index

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (move-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.