Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 32 lines (21 sloc) 1.015 kb
d7016792 »
2011-02-08 FIRST!
1 A `rm -rf` for node.
cabcc5b2 »
2011-02-08 install instructions
2
3 Install with `npm install rimraf`, or just drop rimraf.js somewhere.
15ddf519 »
2011-08-06 Document options
4
5 ## API
6
7 `rimraf(f, [options,] callback)`
8
9 The callback will be called with an error if there is one. Certain
10 errors are handled for you:
11
12 * `EBUSY` - rimraf will back off a maximum of opts.maxBusyTries times
13 before giving up.
14 * `EMFILE` - If too many file descriptors get opened, rimraf will
15 patiently wait until more become available.
16
17 ## Options
18
19 The options object is optional. These fields are respected:
20
21 * `maxBusyTries` - The number of times to retry a file or folder in the
22 event of an `EBUSY` error. The default is 3.
23 * `gently` - If provided a `gently` path, then rimraf will only delete
24 files and folders that are beneath this path, and only delete symbolic
25 links that point to a place within this path. (This is very important
26 to npm's use-case, and shows rimraf's pedigree.)
27
28
29 ## rimraf.sync
30
31 It can remove stuff synchronously, too. But that's not so good. Use
32 the async API. It's better.
Something went wrong with that request. Please try again.