Move-unused-path NPM

Move Unused Path

Reliably move to an unused path.

It is basically a wrapper around get-unused-path which doesn't just return an unused path, but also moves to it.

Install

npm install --save move-unused-path

Usage

It accepts the same options object as get-unused-path, plus the following options:

{
  autoDispose?: boolean // Automatically dispose once the operation is completed, enabled by default
}

It also returns the same return value as get-unused-path.

import fs from 'fs';
import moveUnusedPath from 'move-unused-path';

async function example () {

  const sourceFilePath = '/x/y/z/bar.txt';

  const {folderPath, filePath, fileName} = await moveUnusedPath ( sourceFilePath, {
    folderPath: '/x/y/z',
    fileName: 'foo.txt',
    // maxTries: 1000,
    // incrementer: ( name, ext, attempt ) => attempt > 1 ? `${name}-${attempt}${ext}` : `${name}${ext}`
  });

  console.log ( folderPath ); // => '/x/y/z'
  console.log ( filePath ); // => '/x/y/z/foo (3).txt'
  console.log ( fileName ); // => 'foo (3).txt'

  console.log ( fs.existsSync ( sourceFilePath ) ); // => false
  console.log ( fs.existsSync ( filePath ) ); // => true

}

example ();

get-unused-path: Reliably get an unused path you can write to.
write-unused-path: Reliably write to an unused path.
copy-unused-path: Reliably copy to an unused path.