@emiplegiaqmnpm/cupiditate-eos-temporibus

This is a fork of eugeneware/fs-tail-stream that fixes an encoding issue. Switch back to the original when https://github.com/eugeneware/fs-tail-stream/pull/2 is merged and released.

fs.createReadStream that supports ongoing tailing of files

The built in fs.createReadStream function stops streaming once the file has come to an end.

If you want to tail the file so that it keeps streaming data when the file grows then you're out of luck.

This module adds a { tail: true } option to the options which will keep streaming data as data is added to the file, or until the .close() method is called on the read stream.

Because this module wraps the underlying fs.createReadStream function all the options work as expected.

Installation

This module is installed via npm:

1$ npm install fs-tail-stream

Example Usage

1var fst = require('fs-tail-stream');
2var fs = require('fs');
3var ws = fs.createWriteStream(tmpFile, { flags: 'a' });
4
5// file with the text 'hello' in it
6var tmpFile = '/tmp/my-temp-file.txt';
7
8// same parameters as `fs.createReadStream`, but pass through `tail: true`
9fst.createReadStream(tmpFile, { encoding: 'utf8', start: 80, tail: true })
10  .on('sync', function () {
11    // called when at the end of the file
12    var self = this;
13    // write some new data to the file
14    ws.write('world', 'utf8', function (err) {
15      // stop watching for files, and let the file stream end
16      // otherwise the file watching will be indefinite and the process
17      // won't' exit
18      self.close();
19    });
20  })
21  // will print out both the existing contents of the file, plus the
22  // newly added data
23  .on('data', console.log);
24  // prints out:
25  //   hello
26  //   world