Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

node-dirwalk

0.8.5 • Public • Published

node-dirwalk

Functional directory walking via promises. The library offers you two functions for recursively walking a directory. One, dirWalk, offers you fine grain control for when needing to recursively walk through a directory and the other, dirWalkToTree, does the work for you when all you need is a tree representation of a directory. The library also offers one data type, SjlFileInfo, which can be overridden via the first parameter of dirWalk and dirWalkToTree.

Usage:

Minimalistic approach:

Using dirWalkToTree<TypeRep, dirPath>:
'use strict';

const path = require('path'),
    log = console.log.bind(console),
    dirWalkToTree = require('../src/dirWalkToTree');

// Get tree structure
dirWalkToTree (

    // Use default `TypeRep` (`SjlFileInfo`)
    null,

    // Path to step through
    path.join(__dirname, '/../')

)
    // Return compiled tree to JSON
    .then(JSON.stringify)

    // Print and/or catch
    .then(log, log);

Using dirWalk directly (same as above):
'use strict';

const path = require('path'),
    log = console.log.bind(console),
    dirWalk = require('../src/dirWalk');

// Recursively walk directory
dirWalk (

    // Use default `TypeRep`
    null,

    // Directory effect factory
    (dirPath, stat, dirName) => fileInfoObj => fileInfoObj,     // We're not doing any work here,
                                                                // allowing created file object to pass through
    // File effect factory
    (filePath, stat, fileName) => fileInfoObj => fileInfoObj,   // ""

    // Dir to walk
    path.join(__dirname, '/../')
)
    // Pretty print compiled
    .then(obj => JSON.stringify(obj, null, 4))

    // Log result or catch
    .then(log, log);

Extensive approach

Note: This approach is meant for when side effects are needed or some processing needs to be performed. For creating tree representations of a directory dirWalkToTree should be used.

const path = require('path'),
    dirWalk = require('node-dirwalk');

// Recursively walk directory
dirWalk (
        // Use default `TypeRep`
        null,

        // Directory effect factory
        (dirPath, stat, dirName) => (fileInfoObj, files) => {
            // Side effectual work here
            
            // Our own custom data type - Note this could've easily been acheived with `dirWalkToTree` and just
            // passing in our custom data type constructor.
            return { 
                fileName: dirName,
                filePath: dirPath,
                basename: fileInfoObj.basename,
                files
            };
        },

        // File effect factory
        // ""
        (filePath, stat, fileName) => fileInfoObj => {
            // Side effectual work here
            
            // Our own custom data type - Note this could've easily been acheived with `dirWalkToTree` and just
            // passing in our custom data type constructor.
            return {
                fileName,
                filePath,
                basename: fileInfoObj.basename
            };
        },

        // Dir to walk
        path.join(__dirname, '/../')
    )
    .then(obj => JSON.stringify(obj, null, 4)) // pretty printed
    .then(log, log);

Api:

  • dirWalk
  • dirWalkToTree
  • SjlFileInfo

dirWalk (TypeRep, dirEffectFactory, fileEffectFactory, dir) : Promise

  • TypeRep {Constructor<filePath, stat{fs.Stat}, fileName> | null | undefined} - File node data type constructor. Optional. Default SjlFileInfo.
  • dirEffectFactory {Function<filePath, stat{fs.Stat}, fileName>:Function<fileInfoObj{TypeRep}, files{Array}>} - Call back factory that returns the callback that handles visits to directories Note directory recursion is handled for you by dirWalk, the returned callback here is meant to handle the construction or returning of the data object representing the visited directory.
  • fileEffectFactory {Function<filePath, stat{fs.Stat}, fileName>:Function<fileInfoObj{TypeRep}>} - Same as above but the returned callback doesn't receive a files argument.
  • dir {String} - Directory to walk.
  • returns - A promise with the compiled data tree of visited file/directory nodes visited.

**dirWalkToTree (TypeRep, dirPath) : Promise

  • TypeRep {Constructor<filePath, stat{fs.Stat}, fileName> | null | undefined} - File node data type constructor. Optional. Default SjlFileInfo.
  • dir {String} - Directory to walk.
  • returns - A promise with the compiled data tree of visited file/directory nodes visited.
Example:
const path = require('path'),
    dirWalkToTree = require('node-dir-to-treelike');

// Get tree structure
dirWalkToTree (null, path.join(__dirname, '/../some-dir'))
    .then(obj => JSON.stringify(obj, null, 4)) // pretty printed
    .then(log, log);

**SjlFileInfo {Function <fileName, filePath, stat {fs.Stat}>}

Default data constructor used to construct file objects.

Properties:
  • fileName {String} {enumerable, configurable: false}
  • filePath {String} {enumerable, configurable: false}
  • basename {String} {enumerable, configurable: false}
  • extension {String} {enumerable, configurable: false}
  • lastModified {Date} {enumerable, configurable: false}
  • createdDate {Date} {enumerable, configurable: false}
  • lastChanged {Date} {enumerable, configurable: false}
  • lastAccessed {Date} {enumerable, configurable: false}
  • stat {fs.Stat} {enumerable: false, configurable: false} - Note: When calling JSON.stringify on an object of this type this property is ignored since it is not enumerable.
If represents a directory:
  • files {Array}

References:

Stat notes:

Install

npm i node-dirwalk

DownloadsWeekly Downloads

0

Version

0.8.5

License

ISC

Unpacked Size

50.4 kB

Total Files

12

Last publish

Collaborators

  • avatar