JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 97481575
  • Score
    100M100P100Q243122F
  • License ISC

A deep deletion module for node (like `rm -rf`)

Package Exports

  • rimraf
  • rimraf/bin
  • rimraf/bin.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rimraf) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

The UNIX command rm -rf for node.

Install with npm install rimraf, or just drop rimraf.js somewhere.

API

rimraf(f, callback)

The callback will be called with an error if there is one. Certain errors are handled for you:

  • Windows: 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.

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> which is useful for cross platform support.

mkdirp

If you need to create a directory recursively, check out mkdirp.