npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mixmaxhq/tail

v1.3.0

Published

tail a file in node

Downloads

17

Readme

Tail

NPM

Author: Luca Grulla - www.lucagrulla.com

Installation

npm install tail

Use:

Tail = require('tail').Tail;

tail = new Tail("fileToTail");

tail.on("line", function(data) {
  console.log(data);
});

tail.on("error", function(error) {
  console.log('ERROR: ', error);
});

If you want to stop tail:

tail.unwatch()

To start watching again:

tail.watch()

Configuration

The only mandatory parameter is the path to the file to tail.

var fileToTail = "/path/to/fileToTail.txt";
new Tail(fileToTail)

Optional parameters can be passed via a hash:

var options= {separator: /[\r]{0,1}\n/, fromBeginning: false, startPos: 50, fsWatchOptions: {}, follow: true, logger: console}
new Tail(fileToTail, options)

Available parameters:

  • separator: the line separator token (default /[\r]{0,1}\n/ to handle linux/mac (9+)/windows)
  • fsWatchOptions: the full set of options that can be passed to fs.watch as per node documentation (default: {})
  • fromBeginning: forces the tail of the file from the very beginning of it instead of from the first new line that will be appended (default: false)
  • startPos: forces the tail from certain position, if set — fromBeginning param will be ignored. (default: null)
  • follow: simulate tail -F option. In the case the file is moved/renamed (or logrotated), if set to true tail will try to start tailing again after a 1 second delay, if set to false it will just emit an error event (default: true)
  • logger: a logger object(default: no logger). The passed logger has to respond to two methods:
    • info([data][, ...])
    • error([data][, ...])
  • useWatchFile: if set to true will force the use of fs.watchFile rather than delegating to the library the choice between fs.watch and fs.watchFile (default: false)
  • encoding: the encoding of the file to tail (default:utf-8)

Emitted events

Tail emits four events:

  • line
function(data){
  console.log(data)
}
  • data
function(data){
  console.log(data)
}
  • error
function(exception){}
  • historicalDataEnd
function(end){
  console.log('Historical data size is', end)
}

Want to fork?

Tail is written in CoffeeScript.

The Cakefile generates the javascript that is then published to npm.

Real world use

Tail was born as part of a data firehose. Read about it here.

License

MIT. Please see License file for more details.