Erik Römmelt 5d28bc36e1 node_modules updated, buefy add to lib folder | 5 years ago | |
---|---|---|
.. | ||
LICENSE | 5 years ago | |
README.md | 5 years ago | |
bin.js | 5 years ago | |
package.json | 5 years ago | |
rimraf.js | 5 years ago |
The UNIX command 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 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:
EBUSY
and ENOTEMPTY
- rimraf will back off a maximum of
opts.maxBusyTries
times before giving up, adding 100ms of wait
between each attempt. The default maxBusyTries
is 3.ENOENT
- If the file doesn’t exist, rimraf will return
successfully, since your desired outcome is already the case.EMFILE
- Since readdir
requires opening a file descriptor, it’s
possible to hit EMFILE
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 to
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.