8fc677956b37cd535409bb917f994396e5d0b6f7
[platform/upstream/nodejs.git] / deps / npm / node_modules / rimraf / README.md
1 A `rm -rf` for node.
2
3 Install with `npm install rimraf`, or just drop rimraf.js somewhere.
4
5 ## API
6
7 `rimraf(f, 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
18 ## rimraf.sync
19
20 It can remove stuff synchronously, too.  But that's not so good.  Use
21 the async API.  It's better.
22
23 ## CLI
24
25 If installed with `npm install rimraf -g` it can be used as a global
26 command `rimraf <path>` which is useful for cross platform support.