# uniquefilename

> Finds a unique filename using incremental values

Latest version **1.1.2** (published 2017-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install uniquefilename
pnpm add uniquefilename
yarn add uniquefilename
bun add uniquefilename
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2017-02-28 |
| First published | 2015-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Mickael Burguet |
| Maintainers | rundef |
| Keywords | unique, filename, file, name, uniq |

## Links

- npm: https://www.npmjs.com/package/uniquefilename
- Repository: https://github.com/rundef/node-uniquefilename
- Homepage: https://github.com/rundef/node-uniquefilename#readme
- Issues: https://github.com/rundef/node-uniquefilename/issues
- npm.io page: https://npm.io/package/uniquefilename

## Dependencies (1)

- [bluebird](https://npm.io/package/bluebird.md) ^3.4.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2017-02-28
- 1.1.1 — 2016-10-12
- 1.1.0 — 2016-07-08
- 1.0.7 — 2015-12-13
- 1.0.6 — 2015-09-06
- 1.0.5 — 2015-09-05
- 1.0.4 — 2015-09-05
- 1.0.3 — 2015-09-05
- 1.0.2 — 2015-09-04
- 1.0.1 — 2015-09-04
- 1.0.0 — 2015-09-04

## README

# uniquefilename

[![npm version](https://badge.fury.io/js/uniquefilename.svg)](http://badge.fury.io/js/uniquefilename) 
[![Travis](https://travis-ci.org/rundef/node-uniquefilename.svg?branch=master)](https://travis-ci.org/rundef/node-uniquefilename?branch=master) 
[![bitHound Score](https://www.bithound.io/github/rundef/node-uniquefilename/badges/score.svg)](https://www.bithound.io/github/rundef/node-uniquefilename)
[![Coverage Status](https://coveralls.io/repos/rundef/node-uniquefilename/badge.svg?branch=master&service=github)](https://coveralls.io/github/rundef/node-uniquefilename?branch=master)

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

## Install

```bash
npm install uniquefilename
```

## Usage

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

### Basic example

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

### Example with promises

If a callback is not supplied, a Promise is returned ([using bluebird](https://www.npmjs.com/package/bluebird)).

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

### Advanced example

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

## 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 :

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

## 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 :

```javascript
var multer      = require('multer');
var path      = require('path');
var uniquefilename  = require('uniquefilename');

router.use(multer({
  storage: multer.diskStorage({
    destination: function (req, file, cb) {
      cb(null, './public/uploads/')
    },
    filename: function (req, file, cb) {
      originalname = path.resolve('./public/uploads/' + file.originalname);
      options = {};
      uniquefilename.get(originalname, options, function(filename) {
         cb(null, path.basename(filename));
      });
    }
  })
}).single('thumbnail'));
```

---
_Source: https://npm.io/package/uniquefilename · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._