sfcode
An Online Competing and Development Environment
|
A simple temporary file and directory creator for node.js.
This is a widely used library to create temporary files and directories in a node.js environment.
Tmp offers both an asynchronous and a synchronous API. For all API calls, all the parameters are optional.
Tmp uses crypto for determining random file names, or, when using templates, a six letter random identifier. And just in case that you do not have that much entropy left on your system, Tmp will fall back to pseudo random numbers.
You can set whether you want to remove the temporary file on process exit or not, and the destination directory can also be set.
Simple temporary file creation, the file will be closed and unlinked on process exit.
A synchronous version of the above.
Note that this might throw an exception if either the maximum limit of retries for creating a temporary name fails, or, in case that you do not have the permission to write to the directory where the temporary file should be created in.
Simple temporary directory creation, it will be removed on process exit.
If the directory still contains items on process exit, then it won't be removed.
If you want to cleanup the directory even when there are entries in it, then you can pass the unsafeCleanup
option when creating it.
A synchronous version of the above.
Note that this might throw an exception if either the maximum limit of retries for creating a temporary name fails, or, in case that you do not have the permission to write to the directory where the temporary directory should be created in.
It is possible with this library to generate a unique filename in the specified directory.
A synchronous version of the above.
Creates a file with mode 0644
, prefix will be prefix-
and postfix will be .txt
.
A synchronous version of the above.
Creates a directory with mode 0755
, prefix will be myTmpDir_
.
Again, a synchronous version of the above.
Creates a new temporary directory with mode 0700
and filename like /tmp/tmp-nk2J1u
.
This will behave similarly to the asynchronous version.
The tmpName()
function accepts the prefix
, postfix
, dir
, etc. parameters also:
The tmpNameSync()
function works similarly to tmpName()
.
One may want to cleanup the temporary files even when an uncaught exception occurs. To enforce this, you can call the setGracefulCleanup()
method:
All options are optional :)
mode
: the file mode to create with, it fallbacks to 0600
on file creation and 0700
on directory creationprefix
: the optional prefix, fallbacks to tmp-
if not providedpostfix
: the optional postfix, fallbacks to .tmp
on file creationtemplate
: mkstemp
like filename template, no defaultdir
: the optional temporary directory, fallbacks to system default (guesses from environment)tries
: how many times should the function try to get a unique filename before giving up, default 3
keep
: signals that the temporary file or directory should not be deleted on exit, default is false
, means deletecleanupCallback
function manually.unsafeCleanup
: recursively removes the created temporary directory, even when it's not empty. default is false