Easily create/remove temporary directories
Sometimes you just need a quick and easy way to create temporary directories. Directories are created in the standard OS temporary directory.
Additionally, this module is delivered as:
- ES Module:
dist/stopgap.mjs - CommonJS:
dist/stopgap.js
$ npm install --save stopgap
import stopgap from 'stopgap';
const { path, remove } = await stopgap();
// path ~> /var/folders/c7/fqpgnx7x5654w6z_k3syl11r0000gn/T/sg-LC48Pf
// remove ~> call function to delete directory
// clean up
await remove();Returns: { path: String, remove: Function }
Creates a temporary directory in the OS default temp directory, and returns the an object with two properties:
Type: String
The path to the created directory.
By default this is created as a hidden folder in the users home directory.
Type: Function
Returns: Promise
Invoking this function removes and clean out the temporary directory.
Important: Everything inside the directory is removed recursively.
Type: String
Custom prefix for folder. Defaults to sg-.
Type: String
Custom path for the directory. Path is created recursively.
Defaults to the system tmp directory.
MIT © Terkel Gjervig