scandirectory
Scan a directory recursively with a lot of control and power
Usage
var scandir = require('scandirectory')
var path = process.cwd()
var options = {}
function completionCallback(err, list, tree) {
console.log({
error: err,
list: list,
tree: tree,
})
}
scandir(path, options, completionCallback)
Scan directory options:
action
- (default null
) can be null
or a function to use for both the fileAction and dirActionfileAction
- (default null
) can be null
, false
, or a function to be the action callbackdirAction
- (default null
) can be null
, false
, or a function to the action callbackrecurse
- (default true
) can be null
or a boolean for whether or not to scan subdirectories tooreadFiles
- (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 occuredlist
- 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/directoryrelativePath
- the relative path of the current file/directory with respect to the original scanning pathfilename
- the basename of the current file/directorystat
- 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.
Install
- Install:
npm install --save scandirectory
- Import:
import * as pkg from ('scandirectory')
- Require:
const pkg = require('scandirectory')
This package is published with the following editions:
scandirectory
aliases scandirectory/source/index.js
scandirectory/source/index.js
is ESNext source code for Node.js with Require for modules
History
Discover the release history by heading on over to the HISTORY.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
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: