remove-dir-safe

Remove directories recursively or non-recursively


Keywords
remove, dir, directory, directories, recursively, safe, without, try, catch, throw, throwing, fs-safe, fs
License
MIT
Install
npm install remove-dir-safe@2.0.0

Documentation

remove-dir-safe

NPM TypeScript Coverage Status GitHub Stars Twitter Follow

Remove directories recursively or non-recursively.

  • Returns true if directory no longer exists.
  • Returns false if unable to remove directory.
  • Returns undefined on other errors (ex: permission denied) rather than throwing.

Unless the unsafe flag is set, only directories inside the current working directory or OS temp directory will be removed.

Installation

yarn add remove-dir-safe
npm install remove-dir-safe

API

import { removeDir, removeDirSync, Options } from "write-dir-safe";

function removeDir(path: string, options: Options): Promise<boolean | undefined>;

function removeDirSync(path: string, options: Options): boolean | undefined;

type Options = {
  /**
   * If true, perform a recursive directory removal. Default: `true`
   */
  recursive?: boolean;
  /**
   * Allow removals outside of current working directory, or OS temp directory. Default: `false`
   */
  unsafe?: boolean;
}

Dependenciesdependencies


Dev DependenciesDavid


License license

MIT