https://github.com/jonschlinkert/delete
Delete files and folders and any intermediate directories if they exist (sync and async).
https://github.com/jonschlinkert/delete
del delete file file-system fs glob match remove
Last synced: about 1 month ago
JSON representation
Delete files and folders and any intermediate directories if they exist (sync and async).
- Host: GitHub
- URL: https://github.com/jonschlinkert/delete
- Owner: jonschlinkert
- License: mit
- Created: 2014-06-28T10:24:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-07-02T04:40:47.000Z (almost 8 years ago)
- Last Synced: 2025-04-07T22:48:27.212Z (2 months ago)
- Topics: del, delete, file, file-system, fs, glob, match, remove
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 30.3 KB
- Stars: 24
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# delete [](https://www.npmjs.com/package/delete) [](https://npmjs.org/package/delete) [](https://npmjs.org/package/delete) [](https://travis-ci.org/jonschlinkert/delete)
> Delete files and folders and any intermediate directories if they exist (sync and async).
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save delete
```
## Usage
```js
var del = require('delete');
// async
del(['foo/*.js'], function(err, deleted) {
if (err) throw err;
// deleted files
console.log(deleted);
});
// sync
del.sync(['foo/*.js']);
// promise
del.promise(['foo/*.js'])
.then(function(deleted) {
// deleted files
console.log(deleted)
});
```
## Options
All methods take an `options` object as the second argument.
### options.force
**Type**: `boolean`
**Default**: `undefined`
By default, error is thrown if you try to delete either the current working directory itself, or files outside of the current working directory (e.g. parent directories).
**Examples**
```js
del.sync('../foo.md', {force: true});
del('.', {force: true}, function(err, files) {
// do stuff with err
console.log(files);
});
del.promise('./', {force: true})
.then(function(files) {
console.log(files);
})
```
_(This option was inspired by settings in [grunt](http://gruntjs.com/).)_
## About
### Related projects
* [copy](https://www.npmjs.com/package/copy): Copy files or directories using globs. | [homepage](https://github.com/jonschlinkert/copy "Copy files or directories using globs.")
* [export-files](https://www.npmjs.com/package/export-files): node.js utility for exporting a directory of files as modules. | [homepage](https://github.com/jonschlinkert/export-files "node.js utility for exporting a directory of files as modules.")
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
* [write](https://www.npmjs.com/package/write): Write files to disk, creating intermediate directories if they don't exist. | [homepage](https://github.com/jonschlinkert/write "Write files to disk, creating intermediate directories if they don't exist.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 02, 2017._