Skip to content

taskrjs/fly-clear

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fly-clear Build Status

Remove one or multiple directories

Install

$ npm install --save-dev fly-clear

Usage

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.

License

MIT © Luke Edwards