Skip to content
This repository has been archived by the owner on Aug 8, 2020. It is now read-only.
/ unique-temp-dir Public archive

Provides a uniquely named temp directory

License

Notifications You must be signed in to change notification settings

avajs/unique-temp-dir

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

unique-temp-dir Build Status

Provides a uniquely named temp directory

Install

$ npm install unique-temp-dir

Usage

const uniqueTempDir = require('unique-temp-dir');

uniqueTempDir();
//=> '/var/folders/2_/zg9h6_xd4r3_z7c07s0cn8mw0000gn/T/PpCfz55ANU2hdwnGzgny'

uniqueTempDir();
//=> '/var/folders/2_/zg9h6_xd4r3_z7c07s0cn8mw0000gn/T/qfqafhh1FJulehbCDAPk'

API

uniqueTempDir(options?)

Returns a string that represents a unique directory inside the systems temp directory.

options

Type: object

create

Type: boolean
Default: false

If true, the directory will be created synchronously before returning.

length

Type: number
Default: 20

The length of the directory name inside the temp directory.

thunk

Type: boolean
Default: false

If true, returns a thunk function for path.join(uniqueTempDir, ... additionalArgs). Useful for filling your directory up with stuff.

const uniqueTempDir = require('unique-temp-dir');
const tempDir = uniqueTempDir({thunk: true});

tempDir()
//=> '/user/temp/uniqueId'

tempDir('foo')
//=> '/user/temp/uniqueId/foo'

tempDir('bar')
//=> '/user/temp/uniqueId/bar'