source: trip-planner-front/node_modules/unique-filename/README.md@ e29cc2e

Last change on this file since e29cc2e was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 1.2 KB
Line 
1unique-filename
2===============
3
4Generate a unique filename for use in temporary directories or caches.
5
6```
7var uniqueFilename = require('unique-filename')
8
9// returns something like: /tmp/912ec803b2ce49e4a541068d495ab570
10var randomTmpfile = uniqueFilename(os.tmpdir())
11
12// returns something like: /tmp/my-test-912ec803b2ce49e4a541068d495ab570
13var randomPrefixedTmpfile = uniqueFilename(os.tmpdir(), 'my-test')
14
15var uniqueTmpfile = uniqueFilename('/tmp', 'testing', '/my/thing/to/uniq/on')
16```
17
18### uniqueFilename(*dir*, *fileprefix*, *uniqstr*) → String
19
20Returns the full path of a unique filename that looks like:
21`dir/prefix-7ddd44c0`
22or `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.
27The parameter is required if *uniqstr* is also passed in but is otherwise
28optional and can be `undefined`/`null`/`''`. If present and not empty
29then this string plus a hyphen are prepended to the unique part.
30
31*uniqstr* – Optional, if not passed the unique part of the resulting
32filename will be random. If passed in it will be generated from this string
33in a reproducable way.
Note: See TracBrowser for help on using the repository browser.