1 |
3a515b92
|
cagy
|
unique-filename
|
2 |
|
|
===============
|
3 |
|
|
|
4 |
|
|
Generate a unique filename for use in temporary directories or caches.
|
5 |
|
|
|
6 |
|
|
```
|
7 |
|
|
var uniqueFilename = require('unique-filename')
|
8 |
|
|
|
9 |
|
|
// returns something like: /tmp/912ec803b2ce49e4a541068d495ab570
|
10 |
|
|
var randomTmpfile = uniqueFilename(os.tmpdir())
|
11 |
|
|
|
12 |
|
|
// returns something like: /tmp/my-test-912ec803b2ce49e4a541068d495ab570
|
13 |
|
|
var randomPrefixedTmpfile = uniqueFilename(os.tmpdir(), 'my-test')
|
14 |
|
|
|
15 |
|
|
var uniqueTmpfile = uniqueFilename('/tmp', 'testing', '/my/thing/to/uniq/on')
|
16 |
|
|
```
|
17 |
|
|
|
18 |
|
|
### uniqueFilename(*dir*, *fileprefix*, *uniqstr*) → String
|
19 |
|
|
|
20 |
|
|
Returns the full path of a unique filename that looks like:
|
21 |
|
|
`dir/prefix-7ddd44c0`
|
22 |
|
|
or `dir/7ddd44c0`
|
23 |
|
|
|
24 |
|
|
*dir* – The path you want the filename in. `os.tmpdir()` is a good choice for this.
|
25 |
|
|
|
26 |
|
|
*fileprefix* – A string to append prior to the unique part of the filename.
|
27 |
|
|
The parameter is required if *uniqstr* is also passed in but is otherwise
|
28 |
|
|
optional and can be `undefined`/`null`/`''`. If present and not empty
|
29 |
|
|
then this string plus a hyphen are prepended to the unique part.
|
30 |
|
|
|
31 |
|
|
*uniqstr* – Optional, if not passed the unique part of the resulting
|
32 |
|
|
filename will be random. If passed in it will be generated from this string
|
33 |
|
|
in a reproducable way.
|