node/deps/npm/node_modules/rimraf/README.md

22 lines
540 B
Markdown

A `rm -rf` for node.
Install with `npm install rimraf`, or just drop rimraf.js somewhere.
## API
`rimraf(f, callback)`
The callback will be called with an error if there is one. Certain
errors are handled for you:
* `EBUSY` - rimraf will back off a maximum of opts.maxBusyTries times
before giving up.
* `EMFILE` - If too many file descriptors get opened, rimraf will
patiently wait until more become available.
## rimraf.sync
It can remove stuff synchronously, too. But that's not so good. Use
the async API. It's better.