Scan a directory recursively with a lot of control and power
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
test-fixtures
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
index.js
package.json
test.js

README.md

scandirectory

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Slack community badge Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Scan a directory recursively with a lot of control and power

Install

NPM

  • Install: npm install --save scandirectory
  • Module: require('scandirectory')

Editions

This package is published with the following editions:

  • scandirectory aliases scandirectory/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • scandirectory/source/index.js is Source + ESNext + Require
  • scandirectory/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

var scandir = require('scandirectory')
var path = process.cwd()
var options = {}
function completionCallback (err, list, tree) {
	console.log({
		error: err,
		list: list,
		tree: tree
	})
	/*
	{
		error: null,
		list: {
			'a file.txt': 'file',
			'a directory': 'dir',
			'a directory/a sub file.txt': 'file'
		},
		tree: {
			'a file.txt': true,
			'a directory': {
				'a sub file.txt': 'true
			}
		}
	}
	*/
}
scandir(path, options, completionCallback)

Scan directory options:

  • action - (default null) can be null or a function to use for both the fileAction and dirAction
  • fileAction - (default null) can be null, false, or a function to be the action callback
  • dirAction - (default null) can be null, false, or a function to the action callback
  • recurse - (default true) can be null or a boolean for whether or not to scan subdirectories too
  • readFiles - (default false) can be null or a boolean for whether or not we should read the file contents

The options object is also sent to ignorefs so you can use its options too

The completion callback accepts the following arguments:

  • err - null or an error that has occured
  • list - a collection of all the child nodes in a list/object format:
    • {fileRelativePath: 'dir|file'}
  • tree - a collection of all the child nodes in a tree format:
    • {dir: {dir:{}, file1:true} }
    • if the readFiles option is true, then files will be returned with their contents instead

The results for a specific argument is only generated if the argument is requested.

The action callbacks accept the following arguments:

  • fullPath - the full/absolute path of the current file/directory
  • relativePath - the relative path of the current file/directory with respect to the original scanning path
  • filename - the basename of the current file/directory
  • stat - a simple stat object provided by readdir-cluster

The action callbacks can return false to skip the path from being processed further.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: