diff options
Diffstat (limited to 'deps/npm/node_modules/rimraf/README.md')
| -rw-r--r-- | deps/npm/node_modules/rimraf/README.md | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/deps/npm/node_modules/rimraf/README.md b/deps/npm/node_modules/rimraf/README.md index 96ce9b2a0..cd123b652 100644 --- a/deps/npm/node_modules/rimraf/README.md +++ b/deps/npm/node_modules/rimraf/README.md @@ -1,4 +1,4 @@ -A `rm -rf` for node. +`rm -rf` for node. Install with `npm install rimraf`, or just drop rimraf.js somewhere. @@ -9,13 +9,22 @@ Install with `npm install rimraf`, or just drop rimraf.js somewhere. 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. - +* Windows: `EBUSY` and `ENOTEMPTY` - rimraf will back off a maximum of + `opts.maxBusyTries` times before giving up. +* `ENOENT` - If the file doesn't exist, rimraf will return + successfully, since your desired outcome is already the case. ## rimraf.sync It can remove stuff synchronously, too. But that's not so good. Use the async API. It's better. + +## CLI + +If installed with `npm install rimraf -g` it can be used as a global +command `rimraf <path>` which is useful for cross platform support. + +## mkdirp + +If you need to create a directory recursively, check out +[mkdirp](https://github.com/substack/node-mkdirp). |