fs-crawler

fs-crawler

Crawls the file system and streams the directory/file information.

Installation

Node Dependencies

Execute following line

npm install fs-crawler --save

Require module

var Crawler = require('fs-crawler');

var options = {
  root: '/some/absolut/path/to/directory',
  flushOnEnd: true, // all found filesystem elements are returned on 'end'
  maxDepth: 0       // max subdirectory depth for crawling, 0 = infinity
};

var crawler = new Crawler(options);
crawler.setEncoding('utf8'); // String wanted not Buffer

crawler.on('data', function (data) {
  // information about a file or a directory
  console.log(data);
});

crawler.on('end', function (data) {
  // returns crawl duration in milliseconds
  // and optionally the found elements
  console.log(data);
  
  // recrawls the filesystem using the same options
  crawler.restart(2000);
});

// start streaming
crawler.resume();

Usage

match, matchInRoot, matchInExternal

---

Copyright (c) 2016 Luscus ([e-mail])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.