diff options
Diffstat (limited to 'node_modules/rimraf/README.md')
| -rw-r--r-- | node_modules/rimraf/README.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/node_modules/rimraf/README.md b/node_modules/rimraf/README.md index cd123b652..58e7ac303 100644 --- a/node_modules/rimraf/README.md +++ b/node_modules/rimraf/README.md @@ -1,4 +1,4 @@ -`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. @@ -10,9 +10,15 @@ The callback will be called with an error if there is one. Certain errors are handled for you: * Windows: `EBUSY` and `ENOTEMPTY` - rimraf will back off a maximum of - `opts.maxBusyTries` times before giving up. + `opts.maxBusyTries` times before giving up, adding 100ms of wait + between each attempt. The default `maxBusyTries` is 3. * `ENOENT` - If the file doesn't exist, rimraf will return successfully, since your desired outcome is already the case. +* `EMFILE` - Since `readdir` requires opening a file descriptor, it's + possible to hit `EMFILE` if too many file descriptors are in use. + In the sync case, there's nothing to be done for this. But in the + async case, rimraf will gradually back off with timeouts up to + `opts.emfileWait` ms, which defaults to 1000. ## rimraf.sync |