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

chunking-streams

v0.0.8

Published

NodeJS chunking streams

Downloads

5,572

Readme

node-chunking-streams

Build Status Coverage Status NPM version Dependency Status

A set of Node.js streams to process data in chunks

  1. LineCounter
  2. SeparatorChunker
  3. SizeChunker
  4. GzipChunker
  5. S3MultipartUploader

To intstall with NPM

npm install chunking-streams

To use with Node.JS


var chunkingStreams = require('chunking-streams');

var LineCounter = chunkingStreams.LineCounter;
var SeparatorChunker = chunkingStreams.SeparatorChunker;
var SizeChunker = chunkingStreams.SizeChunker;

// ad so on...

LineCounter

Simple TransformStream which counts lines (\n is a separator) and emit data chunks contains exactly specified number of them.

Configuration

new LineCounter({
    numLines: 1,        // number of lines in a single output chunk. 1 is default
    flushTail: false    // on stream end, flush or not remaining buffer. false is default
});

SeparatorChunker

Split incoming data into chunks based on specified separator. After each separator found data chunk is emitted. By default separator sequence is set to \n, so it is equals to LineCounter with numLines: 1

Configuration

new SeparatorChunker({
    separator: '\n', // separator sequence
    flushTail: false // on stream end, flush or not remaining buffer. false is default
});

SizeChunker

Split streams into chunks having exactly specified number of bytes. It is object mode stream! Each data chunk is an object with the following fields:

  • id: number of chunk (starts from 0)
  • data: Buffer with data

SizeChunker has 2 additional events:

  • chunkStart: emitted on each chunk start.
  • chunkEnd: emitted on each chunk finish.

Both event handlers must accept two arguments:

  • id: number of chunk
  • done: callback function, must be called then processing is completed

If some tail data is not fit fully into specified chunk size, it can be emitted at the end if flushTail flag is set.

Configuration

new SizeChunker({
    chunkSize: 1024 // must be a number greater than zero.
    flushTail: true // flush or not remainder of an incoming stream. Defaults to false
});

Example

var input = fs.createReadStream('./input'),
    chunker = new SizeChunker({
        chunkSize: 1024
    }),
    output;

chunker.on('chunkStart', function(id, done) {
    output = fs.createWriteStream('./output-' + id);
    done();
});

chunker.on('chunkEnd', function(id, done) {
    output.end();
    done();
});

chunker.on('data', function(chunk) {
    output.write(chunk.data);
});

input.pipe(chunker);

S3MultipartUploader

INCOMPLETE