Function dive

  • Recursively walk (“dive”) a directory tree.

    Parameters

    • directory: string

      the pathname of a readable directory

    • options: DiveOptions

      an object that defines some of the properties

    • action: DiveActionCallback

      function that is called on each file

    • complete: (() => void)

      defines a second callback, that is called, when all files have been processed. It takes no arguments.

        • (): void
        • Returns void

    Returns void

    Example

    Default:

    var dive = require('dive');

    dive(process.cwd(), function(err, file) {

    });```

    All files and a callback in the end:

    var dive = require('dive');

    dive(process.cwd(), { all: true }, function(err, file, stat) { if (err) throw err; console.log(file); }, function() { console.log('complete'); });```

    Directories only:

    var dive = require('dive');

    dive(process.cwd(), { directories: true, files: false }, function(err, dir) {
    if (err) throw err;
    console.log(dir);
    });```
  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<void>

Generated using TypeDoc