Code Monkey home page Code Monkey logo

super-stream.each's Introduction

Each

NPM version Build Status Coverage Status Dependency Status devDependency Status MIT Licensed

Better docs comming

See also.
super-stream
super-stream.through
super-stream.map
super-stream.reduce
super-stream.filter
super-stream.junction
super-stream.pipeline


each([options,] [transformFn,] [flushFn]);

this is how
var expect = require('chai').expect;
var each = require("super-stream.each")

var streamA = each.obj(function(counter, enc, done){
  counter += 1;
  done(null, counter);
});
var streamB = each({objectMode: true}, function(counter, enc, done){
  counter += 1;
  done(null, counter);
});

var each = each.factory({objectMode: true});

streamA.pipe(streamB).pipe(each(function(counter, enc, done){
  expect(counter).to.be.equal(2);
}));

streamA.write(0);
var streamA = each(function(chunk, enc, done){
  data = chunk.toString();
  done(null, new Buffer(data +'-'+ data));
});

eachObj = each.factory({objectMode: true});
var streamB = eachObj.buf(function(chunk, enc, done){
  expect(chunk.toString()).to.be.equal('myData-myData');
  done();
});
 
streamA.pipe(streamB);
streamA.write(new Buffer('myData'));

each.obj([transfromFn,] [flushFn])

It is a conveniece method for each({objectMode: true}, transformFn, flushFn);
If called without arguments, returns a passthrough Transform

var stream = each.obj(function(string, enc, done){
  expect(string).to.be.deep.equal({data: 'myData'});
  done();
});
stream.write({data: 'myData'});

each.buf([transfromFn,] [flushFn])

It is a conveniece method for each({objectMode: false}, transformFn, flushFn);
If called without arguments, returns a passthrough Transform

// see the factory method.
var each = each.factory({objectMode: true});
var myData = new Buffer('my data');

var streamBuf = each.buf(function(chunk, enc, done){
  expect(chunk).to.be.equal(myData);
  expect(chunk).to.not.be.equal('my data');
  done();
});
streamBuf.write(myData);

each.factory([options]);

A factory method for creating a custom each instance.

var eachObj = each.factory({objectMode: true});

var streamObj = eachObj(function(string, enc, done){
  expect(string).to.be.equal('my data');
  done();
});
streamObj.write('my data');
var myData = new Buffer('my data');
var eachBuf = each.factory({objectMode: false, highWaterMark: 1000*Math.pow(2,6)});

var streamBuf = eachBuf(function(chunk, enc, done){
  expect(chunk).to.be.equal(myData);
  expect(chunk).to.not.be.equal('my data');
  done();
});
streamBuf.write(myData);

License

The MIT License (MIT)

Copyright (c) 2014 Markuz GJ

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NPM NPM

super-stream.each's People

Contributors

markuz-gj avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.