Package Exports

first-chunk-stream

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (first-chunk-stream) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

first-chunk-stream

Transform the first chunk in a stream

Useful if you want to do something to the first chunk.

You can also set the minimum size of that chunk.

Install

$ npm install --save first-chunk-stream

Usage

var fs = require('fs');
var concat = require('concat-stream');
var firstChunk = require('first-chunk-stream');

// unicorn.txt => unicorn rainbow
// `highWaterMark: 1` means it will only read 1 byte at the time
fs.createReadStream('unicorn.txt', {highWaterMark: 1})
    .pipe(firstChunk({minSize: 7}, function (chunk, enc, cb) {
        this.push(chunk.toUpperCase());
        cb();
    }))
    .pipe(concat(function (data) {
        console.log(data);
        //=> UNICORN rainbow
    }));

API

firstChunk([options], transform)

options.minSize

Type: number

The minimum size of the first chunk.

transform(chunk, encoding, callback)

Required
Type: function

The function that gets the first chunk.

firstChunk.ctor()

Instead of returning a stream.Transform instance, firstChunk.ctor() returns a constructor for a custom Transform. This is useful when you want to use the same transform logic in multiple instances.