uniquefilename

A module to get a filename - that doesn't already exist on the filesystem - using incremental values.

Install

1npm install uniquefilename

Usage

uniquefilename.get(filepath, [options], [callback])

Basic example

1var uniquefilename = require('uniquefilename');
2options = {};
3uniquefilename.get('/path/to/dir/file.jpg', options, function(filename) {
4  // filename might be "/path/to/dir/file.jpg", 
5  // "/path/to/dir/file-2.jpg", "/path/to/dir/file-3.jpg", etc...
6  // depending on the files that exist on your filesystem
7});

Example with promises

If a callback is not supplied, a Promise is returned (using bluebird).

1var uniquefilename = require('uniquefilename');
2uniquefilename.get('/path/to/dir/file.jpg', {}).then(function (filename) {
3  console.log(filename);
4});

Advanced example

1var uniquefilename = require('uniquefilename');
2options = {separator: '~', paddingCharacter: '0', paddingSize: 4, mode: 'alphanumeric'};
3uniquefilename.get('/path/to/dir/file.jpg', options, function(filename) {
4  // filename might be "/path/to/dir/file.jpg", 
5  // "/path/to/dir/file~000h.jpg", "/path/to/dir/file~00h9.jpg", etc...
6  // depending on the files that exist on your filesystem
7});

Options

separator

If the specified filename exists, the separator will be added before the incremental value such as: file{separator}2.jpg

The default value is '-'.

mode

The mode allows you to specify which characters to use to generate the incremental value (the string after the separator)

The default value is 'numeric'.

• 'numeric' Using the following characters: 1234567890
• 'alpha' Using the following characters: abcdefghijklmnopqrstuvwxyz
• 'ALPHA' Using the following characters: ABCDEFGHIJKLMNOPQRSTUVWXYZ
• 'alphanumeric' Using the following characters: 0123456789abcdefghijklmnopqrstuvwxyz
• 'ALPHANUMERIC' Using the following characters: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ
• 'charset' You must specify the characters you wish to use in the charset option

paddingCharacter && paddingSize

If you wish to left-pad the incremental values with a character, use this option. Here's an example :

1var uniquefilename = require('uniquefilename');
2options = {mode: 'alpha', paddingCharacter: '0', paddingSize: 3};
3uniquefilename.get('/path/to/dir/file.jpg', options, function(filename) {
4  // filename might be "/path/to/dir/file.jpg", 
5  // "/path/to/dir/file-002.jpg", "/path/to/dir/file-045.jpg", etc...
6  // depending on the files that exist on your filesystem
7});

alwaysAppend

If alwaysAppend is true filenames will include the separator and attachment from the first request. So instead of file.jpg, file-2.jpg you'd get file-1.jpg, file-2.jpg.

Using it with multer

Multer is a node.js middleware for handling multipart/form-data, which is primarily used for uploading files. The following example shows you how to use multer along with this module to move an uploaded file to a unique filename :

1var multer      = require('multer');
2var path      = require('path');
3var uniquefilename  = require('uniquefilename');
4
5router.use(multer({
6  storage: multer.diskStorage({
7    destination: function (req, file, cb) {
8      cb(null, './public/uploads/')
9    },
10    filename: function (req, file, cb) {
11      originalname = path.resolve('./public/uploads/' + file.originalname);
12      options = {};
13      uniquefilename.get(originalname, options, function(filename) {
14         cb(null, path.basename(filename));
15      });
16    }
17  })
18}).single('thumbnail'));