disposable-directory

Asynchronously creates a disposable directory in the OS temporary directory that gets deleted after the callback is done or errors.

Installation

To install with npm, run:

npm install disposable-directory

Requirements

• Operating system:
  • Linux
  • macOS
• Node.js: ^12.22.0 || ^14.17.0 || >= 16.0.0

API

• function disposableDirectory
• type DisposableDirectoryCallback

function disposableDirectory

Asynchronously creates a disposable directory in the OS temporary directory that gets deleted after the callback is done or errors.

Returns: Promise<void> — Resolves once the callback is done and the disposable directory is deleted.

Examples

Ways to import.

import disposableDirectory from "disposable-directory";

import disposableDirectory from "disposable-directory/disposableDirectory.mjs";

How to use a disposable directory.

disposableDirectory(async (directoryPath) => {
  // Use the directory here.
})
  .then(() => {
    // The directory is gone.
  })
  .catch(() => {
    // The directory is gone.
  });

type DisposableDirectoryCallback

A sync or async callback that receives the temporary directory path.

Type: Function

Returns: void | Promise<void>