diff options
Diffstat (limited to 'node_modules/rimraf/README.md')
| -rw-r--r-- | node_modules/rimraf/README.md | 13 |
1 files changed, 1 insertions, 12 deletions
diff --git a/node_modules/rimraf/README.md b/node_modules/rimraf/README.md index 99983dc43..96ce9b2a0 100644 --- a/node_modules/rimraf/README.md +++ b/node_modules/rimraf/README.md @@ -4,7 +4,7 @@ Install with `npm install rimraf`, or just drop rimraf.js somewhere. ## API -`rimraf(f, [options,] callback)` +`rimraf(f, callback)` The callback will be called with an error if there is one. Certain errors are handled for you: @@ -14,17 +14,6 @@ errors are handled for you: * `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 |