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

fs-find

v0.4.0

Published

Filesystem recursive asynchronous find

Downloads

813

Readme

Table of Contents

Filesystem Find

.

Zero-dependency, asynchronous filesystem walk.

Requires node and npm.

Install

npm i fs-find --save

Usage

find(path, [opts], cb)
var find = require('fs-find')
  , path = process.cwd();
find(path, function(err, results) {
  if(err) {
    return console.error(err);
  }
  console.dir(results);
}

Arguments

  • path: String or array of strings referencing directories and/or files.
  • opts: Processing options, see below.
  • cb: Callback function with signature function(err, results) where results is an array of info objects.

Options

  • dirs: Include directories in results array (default: false).
  • exclude: Do not include the path argument values in the results.
  • filter: Generic filter function before stat is called.
  • file: Filter function for files.
  • folder: Filter function for directories.
  • fullpath: Use full file path for matching.
  • followLinks: Follow symbolic links (stat rather than lstat).
  • depth: Maximum folder depth to recurse.
  • absolute: Make all file paths absolute.
  • dedupe: Remove duplicate entries, possible if the path array contains overlapping folders, best used with absolute enabled.

Filter

Filter functions have the signature function filter(path, info) and should return a boolean. The info object may be modified in place and will be included in the results array.

Info

The info object contains the fields:

  • file: The full file path.
  • name: The basename of the file.
  • folder: The parent folder.
  • matcher: Either the file path or name depending upon the fullpath option.
  • stat: An fs.Stats object when available.
  • base: Base directory for the file.
  • relative: Path relative to base.

Developer

Test

To run the test suite:

npm test

Cover

To generate code coverage:

npm run cover

Lint

Run the source tree through jshint and jscs:

npm run lint

Docs

To build all documentation:

npm run docs

Readme

To build the readme file from the partial definitions (requires mdp):

npm run readme

License

Everything is MIT. Read the license if you feel inclined.

Generated by mdp(1).