summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/rimraf/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/rimraf/README.md')
-rw-r--r--deps/npm/node_modules/rimraf/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/deps/npm/node_modules/rimraf/README.md b/deps/npm/node_modules/rimraf/README.md
new file mode 100644
index 0000000000..99983dc437
--- /dev/null
+++ b/deps/npm/node_modules/rimraf/README.md
@@ -0,0 +1,32 @@
+A `rm -rf` for node.
+
+Install with `npm install rimraf`, or just drop rimraf.js somewhere.
+
+## API
+
+`rimraf(f, [options,] 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.
+
+## Options
+
+The options object is optional. These fields are respected:
+
+* `maxBusyTries` - The number of times to retry a file or folder in the
+ event of an `EBUSY` error. The default is 3.
+* `gently` - If provided a `gently` path, then rimraf will only delete
+ files and folders that are beneath this path, and only delete symbolic
+ links that point to a place within this path. (This is very important
+ to npm's use-case, and shows rimraf's pedigree.)
+
+
+## rimraf.sync
+
+It can remove stuff synchronously, too. But that's not so good. Use
+the async API. It's better.