ft

file-tail

A portable and tiny tail module for Node.js. Similar to tail -F in Unix. Extends node-file-size-watcher.

Showing:

Popularity

Downloads/wk

160

GitHub Stars

9

Maintenance

Last Commit

5yrs ago

Contributors

2

Package

Dependencies

2

Size (min+gzip)

0.7KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Deprecated!
this package is no longer updated or maintained

Readme

node-file-tail

This project is no longer being updated or maintained.

A tiny, portable tail module for Node.js. Similar to tail -F in Unix. Extends node-file-size-watcher. Does not rely on fs.watch, thus works in Windows. Install globally to use the command line tool.

###Usage

    fileTailer = require('file-tail');
    ft = fileTailer.startTailing('logfile.log');
    ft.on('line', function(line){
        // do stuff
    });

###CLI Usage

To use this tool on the command line, just install it globally (npm install -g). Then run nftail <filename>.

###Options

Start tailing with just a file descriptor string, or pass in an object with these properties:

startTailing({
    fd: aFileDescriptor,           // Required
    ms: aFileCheckingInterval,     // Defaults to 100 (milliseconds)
    mode: 'line',                  // The other option is 'stream'
    encoding: 'utf8'               // see Node's fs.createReadStream
    onErr: function(error){};      // immediately listen for 'error' event
});

###Events

  • 'error' -- All errors including ENOENTs are emitted through this.
  • 'tailError' -- 'Error' with ENOENTs ignored; use if you don't care if the file is missing.
  • 'line' -- emitted whenever tailed file grows by a line (or many), unless mode is 'stream'.
  • 'stream' -- If mode is 'stream', will emit a Node.js stream object instead of lines. Use this if you need to preserve every byte or want to handle the details yourself.

Lastly, file-tail objects are just types of file-size-watchers, so you can use everything they have as well. See (https://github.com/alexmiddeleer/node-file-size-watcher)

###Example

Try it out with with this little script (Use with Node script.js fileToTail):

var fd = process.argv[2],
ft = require('file-tail').startTailing(fd);

ft.on('line', function(line) {
    console.log(line);
});

###Help out

Bug reports, feedback, or code contributions are appreciated. All pull requests will be reviewed.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial