Noisy Pneumatic Mnemonic

    scandirectory

    6.16.0 • Public • Published

    scandirectory

    Status of the GitHub Workflow: bevry NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    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,
        })
        /*
    	{
    		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.

    Install

    npm

    • Install: npm install --save scandirectory
    • Import: import * as pkg from ('scandirectory')
    • Require: const pkg = require('scandirectory')

    Editions

    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 10 || 12 || 14 || 16 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:

    Sponsors

    No sponsors yet! Will you be the first?

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal 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:

    Install

    npm i scandirectory

    DownloadsWeekly Downloads

    60,508

    Version

    6.16.0

    License

    MIT

    Unpacked Size

    26.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • balupton
    • bevryme