# @alexbinary/rimraf

> Simple rimraf with promise support 🎉

Latest version **1.0.2** (published 2016-12-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @alexbinary/rimraf
pnpm add @alexbinary/rimraf
yarn add @alexbinary/rimraf
bun add @alexbinary/rimraf
```

## 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 | 1.0.2 |
| Published | 2016-12-29 |
| First published | 2016-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Alexandre Bintz |
| Maintainers | alexbinary |
| Keywords | rm, rimraf, delete, remove, fs, file, directory |

## Links

- npm: https://www.npmjs.com/package/@alexbinary/rimraf
- Repository: https://github.com/alexbinary/rimraf
- Homepage: https://github.com/alexbinary/rimraf#readme
- Issues: https://github.com/alexbinary/rimraf/issues
- npm.io page: https://npm.io/package/@alexbinary/rimraf

## Dependencies (2)

- [rimraf](https://npm.io/package/rimraf.md) ^2.5.4
- [@alexbinary/promisify](https://npm.io/package/@alexbinary/promisify.md) ^3.0.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-12-29
- 1.0.1 — 2016-12-28

## README

# rimraf

Simple rimraf with promise support 🎉

[![npm](https://img.shields.io/npm/v/@alexbinary/rimraf.svg)](https://www.npmjs.com/package/@alexbinary/rimraf)
[![GitHub release](https://img.shields.io/github/release/alexbinary/rimraf.svg?label="github")](https://github.com/alexbinary/rimraf/releases/latest)
[![Build Status](https://travis-ci.org/alexbinary/rimraf.svg)](https://travis-ci.org/alexbinary/rimraf)
[![dependencies Status](https://david-dm.org/alexbinary/rimraf/status.svg)](https://david-dm.org/alexbinary/rimraf)
[![devDependencies Status](https://david-dm.org/alexbinary/rimraf/dev-status.svg)](https://david-dm.org/alexbinary/rimraf?type=dev)

Based on [rimraf](https://www.npmjs.com/package/rimraf) by [isaacs](https://www.npmjs.com/~isaacs)

Uses [@alexbinary/promisify](https://www.npmjs.com/package/@alexbinary/promisify) by [alexbinary](https://www.npmjs.com/~alexbinary)

## Install

Install using npm or yarn :

```bash
$ npm install @alexbinary/rimraf
# or
$ yarn add @alexbinary/rimraf
```

## Usage

```javascript
let rimraf = require('@alexbinary/rimraf')

// promise
rimraf('/foo/bar').then(() => {
  console.log('file deleted')
})

// callback
rimraf('/foo/bar', (err) => {
  if (!err) {
    console.log('file deleted')
  }
})

// sync
rimraf.sync('/foo/bar')
console.log('file deleted')
```

## Documentation

```javascript
let rimraf = require('@alexbinary/rimraf')
```

### rimraf(filepath[, callback])

Removes the file or directory at `filepath`.
If `filepath` is a directory then the directory is removed with all its content.

This method supports both Promise and node callback style, and resolves with no arguments.

### rimraf.sync(filepath)

Synchronous version.

## Licence

MIT

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