An open API service indexing awesome lists of open source software.

https://github.com/taskrjs/fly-clear

Remove one or multiple directories.
https://github.com/taskrjs/fly-clear

Last synced: 23 days ago
JSON representation

Remove one or multiple directories.

Awesome Lists containing this project

README

        

# fly-clear [![Build Status](https://travis-ci.org/flyjs/fly-clear.svg?branch=master)](https://travis-ci.org/flyjs/fly-clear)

> Remove one or multiple directories

## Install

```
$ npm install --save-dev fly-clear
```

## Usage

```js
exports.cleanup = function * (fly) {
// single file
yield fly.clear('foo.js');

// single directory
yield fly.clear('dist');

// multiple directories
yield fly.clear(['dist', 'build']);

// glob pattern(s)
yield fly.clear(['dist/*.css', 'dist/js/*']);

// mixed
yield fly.clear(['foo.js', 'build', 'dist/*.css']);

// with options
yield fly.clear('dist', {maxBusyTries: 5});
}
```

## API

### fly.clear(files, [options])

#### files

Type: `string` or `array`

A filepath, directory path, or glob pattern. For multiple paths, use an `array`.

#### options

Type: `object`

Default: `{}`

All options are passed directly to `rimraf`. Please see its [documentation on options](https://github.com/isaacs/rimraf#options).

## License

MIT © [Luke Edwards](http://flyjs.io)