https://github.com/terkelg/stopgap
Easily create/remove temporary directories.
https://github.com/terkelg/stopgap
directory filesystem io os temporary tmp
Last synced: 8 months ago
JSON representation
Easily create/remove temporary directories.
- Host: GitHub
- URL: https://github.com/terkelg/stopgap
- Owner: terkelg
- License: mit
- Created: 2019-11-01T21:56:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-15T15:57:06.000Z (almost 6 years ago)
- Last Synced: 2025-04-19T20:10:09.958Z (9 months ago)
- Topics: directory, filesystem, io, os, temporary, tmp
- Language: JavaScript
- Homepage:
- Size: 30.3 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# stopgap [](https://github.com/terkelg/stopgap/actions) [](https://codecov.io/gh/terkelg/stopgap)
> 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`](https://unpkg.com/stopgap/dist/stopgap.mjs)
* **CommonJS**: [`dist/stopgap.js`](https://unpkg.com/stopgap/dist/stopgap.js)
## Install
```
$ npm install --save stopgap
```
## Usage
```js
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();
```
## API
### stopgap(opts)
Returns: `{ path: String, remove: Function }`
Creates a temporary directory in the OS default temp directory, and returns the
an object with two properties:
#### path
Type: `String`
The `path` to the created directory.
By default this is created as a hidden folder in the users home directory.
#### remove
Type: `Function`
Returns: `Promise`
Invoking this function removes and clean out the temporary directory.
> **Important:** Everything inside the directory is removed recursively.
### opts.prefix
Type: `String`
Custom prefix for folder. Defaults to `sg-`.
### opts.dir
Type: `String`
Custom path for the directory. Path is created recursively.
Defaults to the system tmp directory.
## License
MIT © [Terkel Gjervig](https://terkel.com)