Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 110 lines (72 sloc) 4.115 kb

Node FileUtils

A collection of utilities that take some of the suck out of working with the file system in Node.

Installation

The package is available over npm and can be installed with:

npm install node-fileutils

One you have it installed, you should be able to include it with:

var fu = require('node-fileutils');

fu.eachFileOrDirectory(...);

Or, if you’re only using one of the methods, you can require it directly with:

var readEachFileMatching = require('node-fileutils').readEachFileMatching;

Examples

Following are some examples that should make it easier to work with these utilities.

eachFileOrDirectory

This is the foundation method that each of the others relies on. This method was designed to address some missing features in the node File System package. When recursively, asynchronously traversing the file system, I would like a handler to be called as soon as each file (or in some cases, directory) is found, but I also want to know the following:

  • Were no files found?
  • Are we finished with the traversal?

The most basic implementation of traversing the file system using only the node library does give us a timely callback, but does not answer the two questions above.

eachFileOrDirectory will recursively, asynchronously traverse the file system starting at the provided directory and will call fileHandler for each file or directory that is found. When traversal is complete, the optional completeHandler will be called (if it is provided).

fileHandler is called with the following arguments:

  • err: Null if no error is found
  • fileOrDirectory: The file or directory name and path
  • stat: A Stat object for the file or directory

completeHandler is called with the following arguments:

  • err: Null if no error is found
  • filesAndDirectories: An Array of all files and directories
  • stats: An Array of all Stat objects (indexed the same as the files)

Following is an example of a simple, typical usage:

eachFileOrDirectory('test/', function(err, fileOrDirectory, stat) {
    if (err) throw err;
    if (!stat.isDirectory()) {
      console.log(">> Found file: " + fileOrDirectory);
    } else {
      console.log(">> Found directory: " + fileOrDirectory);
    }
  });

Following is an example that waits for all files and directories to be
scanned and then uses the entire result to do something:

eachFileOrDirectory('test/', null, function(files, stats) {
    if (err) throw err;
    var len = files.length;
    for (var i = 0; i < len; i++) {
      if (!stats[i].isDirectory()) {
        console.log(">> Found file: " + files[i]);
      } else {
        console.log(">> Found directory: " + files[i]);
      }
    }
  });

eachFile

eachFile works just like eachFileOrDirectory, but even though it recursively traverses the file system, it only calls callback with files, not directories.

eachFileMatching

eachFileMatching works just like eachFile, but it only includes files that match a provided regualar expression.

Following is a simple example of using eachFileMatching:

eachFileMatching(/_test.js/, 'test', function(err, file, stat) {
  if (err) throw err;
  console.log(">> Found file: " + file);
});

readEachFileMatching

readEachFileMatching works just like eachFileMatching, but it also calls callback with the contents of each file that is found. Note that this method should not be used with unusually large files that you might prefer to read with buffers.

readEachFileMatching(/_test.js/, 'test', function(err, file, stat, content) {
  if (err) throw err;
  console.log(">> Found file: " + file + " with: " + content.length + " chars");
});

Issues?

Message me above on Github if you have any questions or issues. I’ll expand to a group of some kind if enough people find this useful.

Something went wrong with that request. Please try again.