Reliably write to an unused path.
It is basically a wrapper around get-unused-path which doesn't just return an unused path, but also writes to it.
- It reliably retrieves an unused path via get-unused-path.
- It attempts to write to it, re-trying in case of failure.
- It writes files atomically.
npm install --save write-unused-pathIt 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 writeUnusedPath from 'write-unused-path';
async function example () {
const content = 'some content';
const {folderPath, filePath, fileName} = await writeUnusedPath ( content, {
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.readFileSync ( filePath, { encoding: 'utf8' } ) ); // => 'some content'
}
example ();- get-unused-path: Reliably get an unused path you can write to.
- copy-unused-path: Reliably copy to an unused path.
- move-unused-path: Reliably move to an unused path.
MIT © Fabio Spampinato