c5fd23b54f | ||
---|---|---|
.. | ||
LICENSE | ||
README.md | ||
bin.js | ||
package.json | ||
rimraf.js |
README.md
The UNIX command rm -rf
for node.
Install with npm install rimraf
, or just drop rimraf.js somewhere.
API
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 to
false
). 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:
- Windows:
EBUSY
andENOTEMPTY
- rimraf will back off a maximum ofopts.maxBusyTries
times before giving up, adding 100ms of wait between each attempt. The defaultmaxBusyTries
is 3. ENOENT
- If the file doesn't exist, rimraf will return successfully, since your desired outcome is already the case.EMFILE
- Sincereaddir
requires opening a file descriptor, it's possible to hitEMFILE
if too many file descriptors are in use. In the sync case, there's nothing to be done for this. But in the async case, rimraf will gradually back off with timeouts up toopts.emfileWait
ms, which defaults to 1000.
rimraf.sync
It can remove stuff synchronously, too. But that's not so good. Use the async API. It's better.
CLI
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.
mkdirp
If you need to create a directory recursively, check out mkdirp.