npm/unique-filename

Name: unique-filename

Owner: npm

Description: Generate a unique filename for use in temporary directories or caches.

Created: 2015-05-07 23:11:46.0

Updated: 2018-05-17 15:12:27.0

Pushed: 2017-11-04 02:45:31.0

Homepage: null

Size: 3

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

unique-filename

Generate a unique filename for use in temporary directories or caches.

uniqueFilename = require('unique-filename')

eturns something like: /tmp/912ec803b2ce49e4a541068d495ab570
randomTmpfile = uniqueFilename(os.tmpdir())

eturns something like: /tmp/my-test-912ec803b2ce49e4a541068d495ab570
randomPrefixedTmpfile = uniqueFilename(os.tmpdir(), 'my-test')

uniqueTmpfile = uniqueFilename('/tmp', '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 reproducable way.