nanite-fill v0.1.0

Nanite - Fill

A readable stream wrapper that can attach a function to fill any writable and transform type streams that are set to objectMode: true. Works with both strings and objects. Designed for use with Nanite.

Installation

To install, simply use npm:

npm install nanite-fill --save

Usage

The example below can be found and ran in the eg folder of the Nanite repository. It demonstrates how to use nanite-fill and nanite-drain with the nanite package. Bear in mind though that this module can be used with any writable or transform stream, not just Nanite.

'use strict'

// create a new instance of nanite and take a
// copy of both the fill and drain modules.
var nanite = require('nanite')(),
    fill = require('nanite-fill'),
    drain = require('nanite-drain')

// set up a basic handler, this should be called
// as many times as there are objects passed to fill.
var handlePrint = nanite.handlerFor({cmd: 'print'})

// drain is a simple write stream that accepts a
// back pressure supported function.
handlePrint(drain(function (msg, done) {
  console.log('Message ' + msg.val + ' handled')
  done()
}))

// fill accepts an array of messages and returns
// a primed readable stream. To push the messages
// into nanite is as simple as piping fill to it.
fill([
  {cmd: 'print', val: 1},
  {cmd: 'print', val: 2},
  {cmd: 'print', val: 3},
  {cmd: 'print', val: 4},
  {cmd: 'print', val: 5}
]).pipe(nanite)

API Overview

Constructor

Requiring nanite-fill produces a builder function for creating Fill instances. Each instance of Fill maintains is it's own Readable stream which can pipe to any writable or transform stream.

var stream = new Writable({objectMode: true})
stream._write = function (msg, enc, done) {
  console.log(msg)
  done()
}

fill([
  {msg: 'hello'},
  {msg: 'hello'}
]).pipe(stream)

FAQ

Can I use Through2 or other stream do-da's with Nanite - Fill ?

Yes! Nanite - Fill itself is a simple readable stream and as such can be piped to any standard writable or transform stream. Most if not all modules based on standard streams should be compatible.

Does it work in browsers ?

Yes! Simply require as normal and let Webpack, Browserify, or other do their magic.

Contributing

Nanite - Fill is an open project and encourages participation. If you feel you can help in any way, be it with examples, extra testing, or new features please be our guest.

See our Contribution Guide for information on obtaining the source and an overview of the tooling used.

License

Copyright Dean McDonnell 2015, Licensed under MIT.