npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fileutils

v1.0.2

Published

Some utilities that diminish the suck of working with the file system in node

Downloads

28

Readme

h1. Node FileUtils

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

h2. Installation

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

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

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

h2. Examples

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

h3. 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:

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

h3. eachFile

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

h3. 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:

h3. 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.

h2. 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.