with-tmp-dir-promise

Run a promise-based function with a temporary directory, deleting it afterwards.

Requires NodeJS 8+.

Installation

1npm install --save with-tmp-dir-promise

Usage example

1const {WithTempDir} = require('with-tmp-dir-promise');
2
3WithTempDir(function (tmpdir) {
4    // tmpdir is a string like '/tmp/q3q235',
5    // pointing to an existing temporary directory
6
7    // Your code goes here
8
9    // When this function returns, the tmp directory will be deleted
10    // Remember to return a Promise here!
11    return Promise.resolve("foobar"); // Example
12}).then(function(arg) {
13    // arg === 'foobar'
14
15    // tmpdir, including all files in the directory,
16    // is deleted here
17});

WithTempDir documentation

1/**
2 * Run the given callback with a newly created temporary directory,
3 * automatically cleaning up once the promise
4 * This function returns a promise that resolves of rejects depending on
5 * A failure in creating the temporary directory causes
6 * immediate rejection without calling the callback.
7 * @param {*} callback A function(tmpPath) retuning a promise
8 * @param {*} opts Options for the tmp library. Default: Also delete files in the directory.
9 * Also supports cleanupAfter opt: If true, cleanup after resolving/rejecting the returned Promise.
10 * If false (default), cleanup before
11 */
12function WithTempDir (callback, opts = {unsafeCleanup: true, cleanupAfter: false}) {
13    // ...
14}