safe-wipe v0.2.5

safe-wipe

Safely wipe a folder.

Overview

This is the perfect library for when you want to wipe a folder with user's confirmation.

• If the folder is empty (or contains only useless files like .DS_Store or Thumbs.db as configured with config.ignore), the folder will be removed without asking anything.
• If config.force is set to true, wipe anyway.
• If the session is not interactive, raise an exception.
• Prompt the user for confirmation, and raise an exception if the answer is negative.

You can configure the following variables:

The messages are:

The function is asynchronous and return a promise. Nothing is passed to the success function, but you'll get an Error instance in the error function. It can have the following code property:

Examples

Simple usage

var safeWipe = require('safe-wipe');

safeWipe('directory', {
  parent: __dirname,
  messages: {
    abort: 'Nope.',
  },
}).then(function () {
  console.log('Successfully removed!');
}, function (e) {
  console.error(e.message, e.code);
});

Bind a config object

var mySafeWipe = safeWipe({
  interactive: false,
});

mySafeWipe('some-directory').then(function () {
  // ...
});

mySafeWipe('another-directory', {
  force: true,
});