https://github.com/npm/unique-filename
Generate a unique filename for use in temporary directories or caches.
https://github.com/npm/unique-filename
npm-cli
Last synced: about 1 year ago
JSON representation
Generate a unique filename for use in temporary directories or caches.
- Host: GitHub
- URL: https://github.com/npm/unique-filename
- Owner: npm
- License: isc
- Created: 2015-05-07T23:11:46.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T18:58:12.000Z (about 1 year ago)
- Last Synced: 2025-05-03T01:03:35.105Z (about 1 year ago)
- Topics: npm-cli
- Language: JavaScript
- Homepage:
- Size: 83 KB
- Stars: 45
- Watchers: 10
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
unique-filename
===============
Generate a unique filename for use in temporary directories or caches.
```js
const uniqueFilename = require('unique-filename')
// returns something like: '/tmp/c5b28f47'
const randomTmpfile = uniqueFilename(os.tmpdir())
// returns something like: '/tmp/my-test-51a7b48d'
const randomPrefixedTmpfile = uniqueFilename(os.tmpdir(), 'my-test')
// returns something like: '/my-tmp-dir/testing-7ddd44c0'
const uniqueTmpfile = uniqueFilename('/my-tmp-dir', 'testing', '/my/thing/to/uniq/on')
```
### uniqueFilename(*dir*, *fileprefix*, *uniqstr*) → String
Returns the full path of a unique filename that looks like:
`dir/prefix-7ddd44c0`
or `dir/7ddd44c0`
*dir* – The path you want the filename in. `os.tmpdir()` is a good choice for this.
*fileprefix* – A string to append prior to the unique part of the filename.
The parameter is required if *uniqstr* is also passed in but is otherwise
optional and can be `undefined`/`null`/`''`. If present and not empty
then this string plus a hyphen are prepended to the unique part.
*uniqstr* – Optional, if not passed the unique part of the resulting
filename will be random. If passed in it will be generated from this string
in a reproducible way.