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

chunky-stream

v0.3.0

Published

Streams groups of chunks based on conditions or an interval

Downloads

8,529

Readme

chunky-stream

Buffer up chunks and push them based on certain conditions or if a period of time has passed. chunk-stream is a simple object-mode transform stream that you can pass any number of testable conditions to force a push/flush of the buffered chunks. It also has a interval feature to allow chunks to flush if a certain time has passed and no further chunks have been received.

  fs.createReadStream(file)
    .pipe(split2())
    .pipe(new ChunkyStream({ interval: 1000 }));

chunky-stream takes in the following options:

  • interval - The amount of time (in ms) to wait since receiving data (0 to disable)
  • ignoreEmpty - If set to true, do not count an empty string as a chunk (i.e. '', default = false)

API

ChunkyStream.use(condition)

This is similar to Express middleware, condition is a function that will run each time a chunk is received to determine whether the buffered chunks should be released. condition should have 1 argument:

  • chunks - The array of chunks currently buffered and not yet flushed. condition should return true if you want to release the chunks to the consumer of the stream, false if you want to continue to buffer.

Examples

Buffer 10 text lines at a time

  var ChunkyStream = require('chunky-stream');
  var split = require('split2');
  var stream = fs.createReadStream('./test.txt');
  var chunk = new ChunkyStream();

  chunk.use(function (chunks) {
    return (chunks.length === 10);
  });

  stream.pipe(split()).pipe(chunk).on('data', function (err, lines) {
    console.log(lines);
  });