unused-filename

Get an unused filename by appending a number if it exists: `file.txt` → `file (1).txt`


Keywords
unused, filename, filepath, file, name, available, safe, unique, usable, filesystem, fs, exists, path
License
MIT
Install
npm install unused-filename@2.1.0

Documentation

unused-filename Build Status

Get an unused filename by appending a number if it exists: file.txtfile (1).txt

Useful for safely writing, copying, moving files without overwriting existing files.

Install

$ npm install unused-filename

Usage

.
├── rainbow (1).txt
├── rainbow.txt
└── unicorn.txt
const unusedFilename = require('unused-filename');

(async () => {
	console.log(await unusedFilename('rainbow.txt'));
	//=> 'rainbow (2).txt'
})();

API

unusedFilename(filePath)

Returns a Promise<string> containing either the original filename or the filename appended with a number.

unusedFilename.sync(filePath)

Returns a string containing either the original filename or the filename appended with a number.

filePath

Type: string

The path to check for filename collision.

Related

  • filenamify - Convert a string to a valid safe filename

License

MIT © Sindre Sorhus