1. module rimraf
   1. function rimraf (p, options, cb)
   2. function rimraf.sync (p, options)

module rimraf

function rimraf (p, options, cb)

• description and source-code

  function rimraf(p, options, cb) {
    if (typeof options === 'function') {
      cb = options
      options = {}
    }
  
    assert(p, 'rimraf: missing path')
    assert.equal(typeof p, 'string', 'rimraf: path should be a string')
    assert.equal(typeof cb, 'function', 'rimraf: callback function required')
    assert(options, 'rimraf: invalid options argument provided')
    assert.equal(typeof options, 'object', 'rimraf: options should be object')
  
    defaults(options)
  
    var busyTries = 0
    var errState = null
    var n = 0
  
    if (options.disableGlob || !glob.hasMagic(p))
      return afterGlob(null, [p])
  
    options.lstat(p, function (er, stat) {
      if (!er)
        return afterGlob(null, [p])
  
      glob(p, options.glob, afterGlob)
    })
  
    function next (er) {
      errState = errState || er
      if (--n === 0)
        cb(errState)
    }
  
    function afterGlob (er, results) {
      if (er)
        return cb(er)
  
      n = results.length
      if (n === 0)
        return cb()
  
      results.forEach(function (p) {
        rimraf_(p, options, function CB (er) {
          if (er) {
            if ((er.code === "EBUSY" || er.code === "ENOTEMPTY" || er.code === "EPERM") &&
                busyTries < options.maxBusyTries) {
              busyTries ++
              var time = busyTries * 100
              // try again, with the same exact callback as this one.
              return setTimeout(function () {
                rimraf_(p, options, CB)
              }, time)
            }
  
            // this one won't happen if graceful-fs is used.
            if (er.code === "EMFILE" && timeout < options.emfileWait) {
              return setTimeout(function () {
                rimraf_(p, options, CB)
              }, timeout ++)
            }
  
            // already gone
            if (er.code === "ENOENT") er = null
          }
  
          timeout = 0
          next(er)
        })
      })
    }
  }

• example usage

  n/a

function rimraf.sync (p, options)

• description and source-code

  function rimrafSync(p, options) {
    options = options || {}
    defaults(options)
  
    assert(p, 'rimraf: missing path')
    assert.equal(typeof p, 'string', 'rimraf: path should be a string')
    assert(options, 'rimraf: missing options')
    assert.equal(typeof options, 'object', 'rimraf: options should be object')
  
    var results
  
    if (options.disableGlob || !glob.hasMagic(p)) {
      results = [p]
    } else {
      try {
        options.lstatSync(p)
        results = [p]
      } catch (er) {
        results = glob.sync(p, options.glob)
      }
    }
  
    if (!results.length)
      return
  
    for (var i = 0; i < results.length; i++) {
      var p = results[i]
  
      try {
        var st = options.lstatSync(p)
      } catch (er) {
        if (er.code === "ENOENT")
          return
  
        // Windows can EPERM on stat.  Life is suffering.
        if (er.code === "EPERM" && isWindows)
          fixWinEPERMSync(p, options, er)
      }
  
      try {
        // sunos lets the root user unlink directories, which is... weird.
        if (st && st.isDirectory())
          rmdirSync(p, options, null)
        else
          options.unlinkSync(p)
      } catch (er) {
        if (er.code === "ENOENT")
          return
        if (er.code === "EPERM")
          return isWindows ? fixWinEPERMSync(p, options, er) : rmdirSync(p, options, er)
        if (er.code !== "EISDIR")
          throw er
  
        rmdirSync(p, options, er)
      }
    }
  }

• example usage

  ...
  In order to use a custom file system library, you can override
  specific fs functions on the options object.
  
  If any of these functions are present on the options object, then
  the supplied function will be used instead of the default fs
  method.
  
  Sync methods are only relevant for `rimraf.sync()`, of course.
  
  For example:
  
  ```javascript
  var myCustomFS = require('some-custom-fs')
  
  rimraf('some-thing', myCustomFS, callback)
  ...