enfsfind-promise v1.0.0

enfsfind-promise

Module that add find functionality to node fs module

enfs stands for Easy Node fs

This module is intended to work as a sub-module of enfs

Description

This module will add a method that allows the obtaining of a list of items in the file system under one directory and sub-directories filtering the result.

• This module will add following methods to node fs module:

  • find
  • findSync
  • findP

Usage

enfsfind

    const enfsfind = require("enfsfind-promise");

Errors

All the methods follows the node culture.

• Async: Every async method returns an Error in the first callback parameter
• Sync: Every sync method throws an Error.

Additional Methods

• find
• findSync
• findP

find

• find(path, options, callback)

Obtain the list of items under a directory and sub-directories asynchronously. Each item will be an object containing: {path: pathToItem, stat: itemStat}

options:

• fs (Object): an alternative fs module to use (default will be enfslist)
• dereference (Boolean): if true will dereference symlinks listing the items to where it points (default: false)
• filter (Function or RegExp): if defined will filter the items in the file system

No Filter:

    enfsfind.find("/home", function(err, listOfItems){
        listOfItems.forEach(function(item){
            //do something
        });
    });

Filter (Function):

    function filterFn(path, stat){
        return stat.isFile() && path.indexOf("mp3") !== -1;
    }
    enfsfind.find("/home", {filter: filterFn},function(err, listOfItems){
        listOfItems.forEach(function(item){
            //do something
        });
    });

Filter (RegExp):

    enfsfind.find("/home", /\.mp3$/,function(err, listOfItems){
        listOfItems.forEach(function(item){
            //do something
        });
    });

findSync

• findSync(path, options)

Obtain the list of items under a directory and sub-directories synchronously Each item will be an object containing: {path: pathToItem, stat: itemStat}

options:

• fs (Object): an alternative fs module to use (default will be enfslist)
• dereference (Boolean): if true will dereference symlinks listing the items to where it points (default: false)
• filter (Function or RegExp): if defined will filter the items in the file system

No Filter:

    let listOfItems = enfsfind.findSync("/home");
    listOfItems.forEach(function(item){
        //do something
    });

Filter (Function):

    function filterFn(path, stat){
        return stat.isFile() && path.indexOf("mp3") !== -1;
    }
    let listOfItems = enfsfind.findSync("/home", {filter: filterFn});
    listOfItems.forEach(function(item){
        //do something
    });

Filter (RegExp):

    let listOfItems = enfsfind.findSync("/home", /\.mp3$/);
    listOfItems.forEach(function(item){
        //do something
    });

findP

• findP(path, options)

Obtain the list of items under a directory and sub-directories asynchronously. Each item will be an object containing: {path: pathToItem, stat: itemStat}

options:

• fs (Object): an alternative fs module to use (default will be enfslist)
• dereference (Boolean): if true will dereference symlinks listing the items to where it points (default: false)
• filter (Function or RegExp): if defined will filter the items in the file system

No Filter:

    enfsfind.findP("/home").then(function(listOfItems){
        listOfItems.forEach(function(item){
            //do something
        });
    });

Filter (Function):

    function filterFn(path, stat){
        return stat.isFile() && path.indexOf("mp3") !== -1;
    }
    enfsfind.findP("/home", {filter: filterFn}).then(function(listOfItems){
        listOfItems.forEach(function(item){
            //do something
        });
    });

Filter (RegExp):

    enfsfind.find("/home", /\.mp3$/).then(function(listOfItems){
        listOfItems.forEach(function(item){
            //do something
        });
    });

License

Creative Commons Attribution 4.0 International License

Copyright (c) 2016 Joao Parreira joaofrparreira@gmail.com GitHub

This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit CC-BY-4.0.