findit

What is findit?

The 'findit' npm package is a simple and efficient tool for recursively searching through directories to find files and directories. It emits events for each file and directory it encounters, making it easy to handle file system traversal in a Node.js application.

What are findit's main functionalities?

Finding Files

This feature allows you to search for files within a specified directory. The 'file' event is emitted for each file found, and you can handle it by logging the file path or performing other operations.

const findit = require('findit');
const finder = findit('/path/to/search');

finder.on('file', (file, stat) => {
  console.log('File: ' + file);
});

Finding Directories

This feature allows you to search for directories within a specified directory. The 'directory' event is emitted for each directory found, and you can handle it by logging the directory path or performing other operations.

const findit = require('findit');
const finder = findit('/path/to/search');

finder.on('directory', (dir, stat, stop) => {
  console.log('Directory: ' + dir);
});

Handling Errors

This feature allows you to handle errors that occur during the search process. The 'error' event is emitted when an error is encountered, and you can handle it by logging the error or performing other error-handling operations.

const findit = require('findit');
const finder = findit('/path/to/search');

finder.on('error', (err) => {
  console.error('Error: ' + err);
});

Stopping the Search

This feature allows you to stop the search process based on certain conditions. The 'stop' function can be called within the 'directory' event handler to halt the search when a specific directory is encountered.

const findit = require('findit');
const finder = findit('/path/to/search');

finder.on('directory', (dir, stat, stop) => {
  if (dir === '/path/to/stop') stop();
});

Other packages similar to findit

glob

The 'glob' package allows for pattern matching and file searching using glob patterns. It is more flexible in terms of specifying patterns for file matching compared to 'findit', but it may be less efficient for large directory trees.

readdirp

The 'readdirp' package provides a recursive version of 'fs.readdir'. It offers a more modern API with promises and streams, making it easier to integrate with async/await syntax. It is similar to 'findit' in terms of functionality but provides more modern features.

walk

The 'walk' package is another alternative for recursively walking through directories. It provides a similar event-based API to 'findit' but includes additional features like filtering and limiting the depth of the search.

README

findit

Recursively walk directory trees. Think /usr/bin/find.

example

var finder = require('findit')(process.argv[2] || '.');
var path = require('path');

finder.on('directory', function (dir, stat, stop) {
    var base = path.basename(dir);
    if (base === '.git' || base === 'node_modules') stop()
    else console.log(dir + '/')
});

finder.on('file', function (file, stat) {
    console.log(file);
});

finder.on('link', function (link, stat) {
    console.log(link);
});

methods

var find = require('findit')

var finder = find(basedir, opts)

Return an event emitter finder that performs a recursive walk starting at basedir.

If you set opts.followSymlinks, symlinks will be followed. Otherwise, a 'link' event will fire but symlinked directories will not be walked.

If basedir is actually a non-directory regular file, findit emits a single "file" event for it then emits "end".

You can optionally specify a custom fs implementation with opts.fs. opts.fs should implement:

• opts.fs.readdir(dir, cb)
• opts.fs.lstat(dir, cb)
• opts.fs.readlink(dir, cb) - optional if your stat objects from opts.fs.lstat never return true for stat.isSymbolicLink()

finder.stop()

Stop the traversal. A "stop" event will fire and then no more events will fire.

events

finder.on('path', function (file, stat) {})

For each file, directory, and symlink file, this event fires.

finder.on('file', function (file, stat) {})

For each file, this event fires.

finder.on('directory', function (dir, stat, stop) {})

For each directory, this event fires with the path dir.

Your callback may call stop() on the first tick to tell findit to stop walking the current directory.

finder.on('link', function (file, stat) {})

For each symlink, this event fires.

finder.on('readlink', function (src, dst) {})

Every time a symlink is read when opts.followSymlinks is on, this event fires.

finder.on('end', function () {})

When the recursive walk is complete unless finder.stop() was called, this event fires.

finder.on('stop', function () {})

When finder.stop() is called, this event fires.

finder.on('error', function (err) {})

Whenever there is an error, this event fires. You can choose to ignore errors or stop the traversal using finder.stop().

You can always get the source of the error by checking err.path.

install

With npm do:

npm install findit

license

MIT