Giter VIP home page Giter VIP logo

node-folder-tail's Introduction

node-folder-tail

Recursive Tail -F on a directory. Automatically detects and tails new files.

###Usage

	var mod = require("folder-tail"),
	fd      = "aFolder",
	ft      = mod.startTailing(fd, function(e) {
		console.log(e);
	});
	
	ft.on('line', function(line) {
		console.log(fd + " grew: " + line);
	});

###Details

Requiring the module returns an object with one method:

startTailing(fd, onErr, [ext, interval])

  • fd: A file descriptor for the folder
  • onErr: error handler function. Is passed an error object. Is called every time an error is encountered.
  • ext (optional): A string used to filter files (e.g. '*.log' to filter out log files). You can use any glob expression (see the npm module minimatch for more details). Defaults to '*'.
  • interval (optional): Milliseconds to wait before looking for new files. Defaults to 1000.

This method returns an eventEmitter that emits the following events (besides 'error')

  • 'line': passes two strings to listeners; the new line and its associated file descriptor

###Notes

Error handling is not yet finalized/formalized. Please listen for error events and be careful.

Code contributions, bug reports, etc. are welcome. Just use the normal Github channels.

node-folder-tail's People

Contributors

alexmiddeleer avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.