Code Monkey home page Code Monkey logo

superpipe's Introduction

SuperPipe

CI status License MIT NPM version Dependencies Coverage Status Code Climate

Sauce Test Status

Hire SuperPipe for your complex reactive javascript application

Quick Start

The easiest way to install SuperPipe is with npm

npm install superpipe

Usage example

var SuperPipe = require('superpipe');

var sp = new SuperPipe();

Example

Documentation

Below is a description of exposed public API

Constructor([insider])

SuperPipe constructor can take 1 parameter:

var SuperPipe = require('superpipe')

var superpipe = new SuperPipe()

or

var insider = require('insider')
var SuperPipe = require('superpipe')

var superpipe = new SuperPipe(insider)

.listenTo([eventEmitter],eventName)

Return a new pipeline. Listen to the event of emitter and create a new pipeline to handle the emitted events. The listenTo can take 2 parameters:

  • eventEmitter - instance of EventEmitter. Optional parameter. If you not provide eventEmitter, will be used instaoce of superpipe
  • eventName - name of event for listen. For example superpipe.listenTo('login')

.pipeline()

Return a new pipeline instance

.autoBind({Boolean})

The autoBind can take 1 parameter. Paramater is boolean.The .autoBind() controls if we should automatically bind the function dependency

var SuperPipe = require('superpipe')
var superpipe = new SuperPipe()

var loginPipeline = superpipe
  .pipeline()
  .autoBind(true)
  .pipe(...)
  .pipe(...)
  .toPipe()

.setDep(name,dep,[props])

The setDep can take 3 parameters.

  • name - Required {String} Name of the dependency to set or prefix if props is present.
  • dep - Required {String,Object,Array,Number,Boolean,Function}
  • props - Optional {String} Name(s) of properties to set as dependencies or shortcuts. You can set props in 3 ways :
    • '*' - set all the properties of the object as dependencies.
    • '*^' - set all the function properties of the object as dependencies.
    • '*$' - set all non-function properties of the object as dependencies.

Example without props

var SuperPipe = require('superpipe')
var superpipe = new SuperPipe()

var secret = 'secret-key'
var x = 5

superpipe
  .setDep('secret',secret)
  .setDep('y',x)  // you can make another name of dep then your variable or function

Example with 'props'

// For example we have a module that does math operations
// name of file math.js

module.exports = {
  add: function(x,y,setDep){
    ...
  },
  sub: function(x,y,setDep){
    ...
  },
  z: 10
}
var SuperPipe = require('superpipe')
var superpipe = new SuperPipe()
var math = require('./math')

superpipe
  .setDep('math1',math,'*')  // you can get add,sub,z
  .setDep('math2',math,'*^') // you can get just add and sub (func)
  .setDep('math3',math,'*$') // you can get just z (non-func)

.getDep(name)

The getDep can take 1 parameter

  • name - Required {String} Name of the dependency
var SuperPipe = require('superpipe')
var superpipe = new SuperPipe()

var x = 5

superpipe
  .setDep('x',x)

var z = superpipe.getDep('x') // z = 5

Bug Reports here

superpipe's People

Contributors

lsm avatar nikolenkoanton92 avatar

Stargazers

 avatar

Watchers

 avatar James Cloos avatar  avatar  avatar

superpipe's Issues

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.