The [UNIX command](http://en.wikipedia.org/wiki/Rm_(Unix)) rm -rf
for node.
Install with npm install rimraf
, or just drop rimraf.js somewhere.
rimraf(f, [opts], callback)
The first parameter will be interpreted as a globbing pattern for files. If you
want to disable globbing you can do so with opts.disableGlob
(defaults tofalse
). This might be handy, for instance, if you have filenames that contain
globbing wildcard characters.
The callback will be called with an error if there is one. Certain
errors are handled for you:
EBUSY
and ENOTEMPTY
- rimraf will back off a maximum ofopts.maxBusyTries
times before giving up, adding 100ms of waitmaxBusyTries
is 3.ENOENT
- If the file doesn't exist, rimraf will returnEMFILE
- Since readdir
requires opening a file descriptor, it'sEMFILE
if too many file descriptors are in use.opts.emfileWait
ms, which defaults to 1000.It can remove stuff synchronously, too. But that's not so good. Use
the async API. It's better.
If installed with npm install rimraf -g
it can be used as a global
command rimraf <path> [<path> ...]
which is useful for cross platform support.
If you need to create a directory recursively, check out
mkdirp.