move-file
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    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

    import {moveFile} from 'move-file';
    
    await moveFile('source/unicorn.png', 'destination/unicorn.png');
    console.log('The file has been moved');

    API

    moveFile(sourcePath, destinationPath, options?)

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

    moveFileSync(sourcePath, destinationPath, options?)

    sourcePath

    Type: string

    The file you want to move.

    destinationPath

    Type: string

    Where you want the file moved.

    options

    Type: object

    overwrite

    Type: boolean
    Default: true

    Overwrite existing destination file.

    directoryMode

    Type: number
    Default: 0o777

    Permissions for created directories.

    It has no effect on Windows.

    Related

    Install

    npm i move-file

    DownloadsWeekly Downloads

    169,805

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    6.35 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus