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

tick-stream

v1.0.0

Published

A simple transform stream that can log a tick every time data is pushed through a pipe

Downloads

16

Readme

tick-stream

npm version CircleCI codecov.io JavaScript Style Guide

A simple transform stream that can log a tick every time data is pushed through a pipe.

Rationale

You have a long running pipe of streams doing stuff. It's very common that, while the pipe is being processed, you want to see some progress. How many times did you have to implement your own stream just to console log some sort of progress?

Well, now you don't have to do that anymore and you can simply use tick-stream for that:

const TickStream = require('tick-stream')

// initialize stream1, stream2 and stream3 somehow here

stream1
  .pipe(stream2)
  .pipe(stream3)
  .pipe(new TickStream())

This code will produce an output similar to this:

tick: 0
tick: 1
tick: 2
tick: 3

Every line is outputted once a chunk of data has been processed by the stream.

Install

With NPM:

npm install --save tick-stream

Usage

tick-stream is a Transform stream that logs a message to show progress and passes the received data to the next stream without applying any change to it.

By default the log message will count the number of chunks processed (ticks) using console.log.

You can provide your own custom logging function with the logFunction option:

const TickStream = require('tick-stream')

const tick = new TickStream({
  logFunction: (chunk, encoding, tick) => {
    console.log(`I am processing chunk #${tick}`, chunk)
  }
})

In case you are working with object streams you will need to initialize your tick-stream instance in objectMode:

const TickStream = require('tick-stream')

const tick = new TickStream({ objectMode: true })

Contributing

Everyone is very welcome to contribute to this project. You can contribute just by submitting bugs or suggesting improvements by opening an issue on GitHub.

License

Licensed under MIT License. © Luciano Mammino.