dir-roll-up v1.8.0

dir-roll-up

Module to get space usage for all sub directories in a path.

Try on RunKit

Implemented as an asynchronous generator that only uses core modules:

• Responsive and non-blocking
• Lower runtime memory usage

Installing

npm install dir-roll-up

Examples

Each directory is returned as a node in the following format:

{
  "id": "8abf23ea00bbf8ac2ff47b6ecba9984f",
  "depth": 1,
  "fileCount": 5,
  "sizeOfDir": 2032,
  "rollupSize": 259737,
  "dirName": ".git",
  "parent": "5058f1af8388633f609cadb75a75dc9d"
}

1) Directories aggregated

List all directories under current location. Each node is only returned once, when its total size is aggregated, resulting in a bottom-up retrieval.

const dirRollUp = require("dir-roll-up");

(async () => {
  for await (let dirNode of dirRollUp(".")) {
    console.log(dirNode);
  }
})();

2) Directories including partial updates

Directories are repeatedly emitted as the total size is increased for each aggregated sub directory. This is configured by passing an option {includePartial: true}

const dirRollUp = require("dir-roll-up");

(async () => {
  for await (let dirNode of dirRollUp(".", {includePartial: true})) {
    console.log(dirNode);
  }
})();

3) Get directories from an interval

Get each directory node, as required (in an interval loop), as an example of the non-blocking approach

const dirRollUp = require("dir-roll-up");

const dirNodeGenerator = dirRollUp(".");

const interval = setInterval(async () => {

  /**
   * Get the next directory...
   */
  const dirNode = await dirNodeGenerator.next();

  /**
   * ..display it..
   */
  console.log(dirNode.value);

  /**
   * ..and end the interval when last directory retrieved (which will be the root)
   */
  if (dirNode.done) {
    console.log("Finished!");
    clearInterval(interval);
  }
}, 300);