| Dir : /opt/alt/alt-nodejs14/root/usr/lib/node_modules/npm/node_modules/fs-vacuum/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //opt/alt/alt-nodejs14/root/usr/lib/node_modules/npm/node_modules/fs-vacuum/README.md |
# 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.