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

filesystem-traverse

v2.0.2

Published

Traverse the filesystem providing a callback per file and a Promise to return on completion. Directory and file level include and exclude filters can be set. The resultant value for the promise is an array of the callback results.

Downloads

29

Readme

traverse(options): Promise<Array>

Traverses the filesystem applying process_file to all files under the given directory.

arguments

options:

{
  directory?: string,
  process_file: (filepath: string) => T,
  include_file?: string | RegExp,
  exclude_file?: string | RegExp,
  include_dir?: string | RegExp,
  exclude_dir?: string | RegExp,
  fs?: typeof fs
}
  • directory?: string - The directory from which to recursively process files. Defaults to the current working directory of the process.
  • process_file: (filepath: string) => T - A function to be called on each file traversed; the return values become members of the result array.
  • include_file: string | RegExp - An optional regex filter that is applied to discovered files. Only files that match are processed - unless they match the exclude_file filter. Defaults to all files.
  • exclude_file: string | RegExp - An optional regex filter that is applied to discovered files. Only files that do not match are processed. Defaults to no files.
  • include_dir: string | RegExp - An optional regex filter that is applied to discovered directories. If a directory does not match it will not be entered and the files inside will not be processed. Defaults to all directories.
  • exclude_dir: string | RegExp - An optional regex filter that is applied to discovered directories. If a directory matches it will not be entered and the files inside will not be processed. Defaults to no directories.
  • fs: FS - An optional fs module, such as memfs. Defaults to the NodeJS fs module.

return

  • Promise<Array<T>> - A promise that resolves once all of the process_file functions return, and resolves to an array of the return values of process_file. The order of the array is not guaranteed.

Examples