diff options
Diffstat (limited to 'node_modules/rimraf/README.md')
| -rw-r--r-- | node_modules/rimraf/README.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/node_modules/rimraf/README.md b/node_modules/rimraf/README.md index 18659f67f..de7c4bbfa 100644 --- a/node_modules/rimraf/README.md +++ b/node_modules/rimraf/README.md @@ -1,12 +1,17 @@ [](https://travis-ci.org/isaacs/rimraf) [](https://david-dm.org/isaacs/rimraf) [](https://david-dm.org/isaacs/rimraf#info=devDependencies) -The [UNIX command](http://en.wikipedia.org/wiki/Rm_(Unix)) `rm -rf` for node. +The [UNIX command](http://en.wikipedia.org/wiki/Rm_(Unix)) `rm -rf` for node. Install with `npm install rimraf`, or just drop rimraf.js somewhere. ## API -`rimraf(f, callback)` +`rimraf(f, [opts], callback)` + +The first parameter will be interpreted as a globbing pattern for files. If you +want to disable globbing you can do so with `opts.disableGlob` (defaults to +`false`). This might be handy, for instance, if you have filenames that contain +globbing wildcard characters. The callback will be called with an error if there is one. Certain errors are handled for you: |