# remove-dir-safe

> Remove directories recursively or non-recursively

Latest version **2.0.0** (published 2021-06-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install remove-dir-safe
pnpm add remove-dir-safe
yarn add remove-dir-safe
bun add remove-dir-safe
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-06-08 |
| First published | 2020-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Connor White |
| Maintainers | bconnorwhite |
| Keywords | remove, dir, directory, directories, recursively, safe, without, try, catch, throw, throwing, fs-safe, fs |

## Links

- npm: https://www.npmjs.com/package/remove-dir-safe
- Repository: https://github.com/bconnorwhite/remove-dir-safe
- Homepage: https://connorwhite.org/github/remove-dir-safe
- npm.io page: https://npm.io/package/remove-dir-safe

## Dependencies (1)

- [is-path-inside](https://npm.io/package/is-path-inside.md) 3.0.3

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-06-08
- 1.0.1 — 2020-10-04
- 1.0.0 — 2020-10-03

## README

<div align="center">
  <h1>remove-dir-safe</h1>
  <a href="https://npmjs.com/package/remove-dir-safe">
    <img alt="NPM" src="https://img.shields.io/npm/v/remove-dir-safe.svg">
  </a>
  <a href="https://github.com/bconnorwhite/remove-dir-safe">
    <img alt="TypeScript" src="https://img.shields.io/github/languages/top/bconnorwhite/remove-dir-safe.svg">
  </a>
  <a href="https://coveralls.io/github/bconnorwhite/remove-dir-safe?branch=master">
    <img alt="Coverage Status" src="https://coveralls.io/repos/github/bconnorwhite/remove-dir-safe/badge.svg?branch=master">
  </a>
  <a href="https://github.com/bconnorwhite/remove-dir-safe">
    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/bconnorwhite/remove-dir-safe?label=Stars%20Appreciated%21&style=social">
  </a>
  <a href="https://twitter.com/bconnorwhite">
    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/bconnorwhite.svg?label=%40bconnorwhite&style=social">
  </a>
</div>

<br />

> 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

```sh
yarn add remove-dir-safe
```

```sh
npm install remove-dir-safe
```

## API

```ts
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;
}
```

<br />

<h2>Dependencies<img align="right" alt="dependencies" src="https://img.shields.io/david/bconnorwhite/remove-dir-safe.svg"></h2>

- [is-path-inside](https://www.npmjs.com/package/is-path-inside): Check if a path is inside another path

<br />

<h2>Dev Dependencies<img align="right" alt="David" src="https://img.shields.io/david/dev/bconnorwhite/remove-dir-safe.svg"></h2>

- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects
- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs
- [@types/node](https://www.npmjs.com/package/@types/node): TypeScript definitions for Node.js
- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system.  You know, for testing.

<br />

<h2>License <img align="right" alt="license" src="https://img.shields.io/npm/l/remove-dir-safe.svg"></h2>

[MIT](https://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/remove-dir-safe · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._