map-stream / 0.0.6 last updated a year ago created on Aug 18th 2012

Install

npm install --save map-stream

Clone

git clone git@github.com:dominictarr/map-stream.git

dependencies

No dependencies listed.

maintainers

dominictarr

versions 6 total

0.1.0 2 years ago dominictarr
0.0.6 a year ago dominictarr
0.0.5 2 years ago dominictarr
0.0.4 3 years ago dominictarr
0.0.3 3 years ago dominictarr
0.0.2 3 years ago dominictarr
23587 Downloads yesterday.

readme

MapStream

Refactored out of event-stream

map (asyncFunction[, options])

Create a through stream from an asyncronous function.

1
2
3
4
5
6
7
var map = require('map-stream')

map(function (data, callback) {
  //transform data
  // ...
  callback(null, data)
})

Each map MUST call the callback. It may callback with data, with an error or with no arguments,

  • callback() drop this data.
    this makes the map work like filter,
    note:callback(null,null) is not the same, and will emit null

  • callback(null, newData) turn data into newData

  • callback(error) emit an error for this item.

Note: if a callback is not called, map will think that it is still being processed,
every call must be answered or the stream will not know when to end.

Also, if the callback is called more than once, every call but the first will be ignored.

Options

  • failures - boolean continue mapping even if error occured. On error map-stream will emit failure event. (default: false)
Resolving all dependencies.. This could take a while as our cache is not yet fully warmed up.