?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 1.19 KB

/lib/node_modules/npm/node_modules/fs-vacuum/README.md

Text Base64

# fs-vacuum

Remove the empty branches of a directory tree, optionally up to (but not
including) a specified base directory. Optionally nukes the leaf directory.

## Usage

```javascript
var logger = require("npmlog");
var vacuum = require("fs-vacuum");

var options = {
  base  : "/path/to/my/tree/root",
  purge : true,
  log   : logger.silly.bind(logger, "myCleanup")
};

/* Assuming there are no other files or directories in "out", "to", or "my",
 * the final path will just be "/path/to/my/tree/root".
 */
vacuum("/path/to/my/tree/root/out/to/my/files", options, function (error) {
  if (error) console.error("Unable to cleanly vacuum:", error.message);
});
```
# vacuum(directory, options, callback)

* `directory` {String} Leaf node to remove. **Must be a directory, symlink, or file.**
* `options` {Object}
  * `base` {String} No directories at or above this level of the filesystem will be removed.
  * `purge` {Boolean} If set, nuke the whole leaf directory, including its contents.
  * `log` {Function} A logging function that takes `npmlog`-compatible argument lists.
* `callback` {Function} Function to call once vacuuming is complete.
  * `error` {Error} What went wrong along the way, if anything.

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
.eslintrc	421 B	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
.npmignore	13 B	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
.travis.yml	215 B	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
LICENSE	736 B	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
package.json	1.52 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
README.md	1.19 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive
vacuum.js	3.22 KB	lrw-r--r--	2021-03-10 14:36:39	Edit Download recursive recursive

Directory Contents