step.js

3.1.0 • Public • Published

step.js

My kind of step library. 100 lines of code. 384 lines of tests.

Installation

In the browser (component):

  $ component install matthewmueller/step.js

In node:

  $ npm install step.js

Features

Similar to ware with a few key differences:

  • transform support, return values update the argument passed through while undefined will pass the previous value through
  • synchronous, asynchronous, generator, & promise support
  • errors skip to end immediately (errors cannot be caught by middleware)

Example

function fetch(notes, posts, next) {
  // fetch notes and posts
  next(null, notes, posts)
}
 
function *compare(notes, posts) {
  // compare, update posts if necessary
  return updated;
}
 
step(notes, posts)(fetch, compare, function(err, updated) {
  if(err) throw err;
  console.log(updated);
});

Installation

With node.js:

npm install step.js

With component:

component install matthewmueller/step.js

API

Step(args, ...)([fn|generator|promise|arr|step], ...)

Initialize step. Returns a function to chain functions, generators, arrays, and other step instances.

Step('a', 'b')(fn1, fn2, done);

Also supports a context:

Step('a', 'b').call({}, fn1, fn2, done);

License

(The MIT License)

Copyright (c) 2014 matthew mueller <mattmuelle@gmail.com>

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.

Readme

Keywords

none

Package Sidebar

Install

npm i step.js

Weekly Downloads

18

Version

3.1.0

License

none

Last publish

Collaborators

  • mattmueller