spidey-boy v1.0.1

Spidey Boy 🕷 🕸

A simple utility for crawling a file system.

Installation

npm install spidey-boy

Working with Spidey Boy

The utility has perhaps the simplest API possible, with only a single method:

Promise = spideyBoy.crawl(pathToRootDirectory, actionPerFile, options?)

Where:

• pathToRootDirectory is a string pointing to a directory to crawl. This can be absolute or relative to the current working directory
• actionPerFile is a function that will be executed per file found. It receives an absolute path to the file as its sole argument
• options an optional object with the following properties
  • exclude an array of strings containing directories or files to exclude from the crawl