co-eventemitter v0.0.21

co-eventemitter

co-eventemitter for JavaScript

Installing

$ npm install co-eventemitter

Getting starter

let CoEvent = require( 'co-eventemitter' )
let ctx = {a:2}
let separator = '::'
let coEvent = new CoEvent(ctx,separators) // you can pass a object to co-eventemitter constructor
// that will be used or passed as thisArg to every generator.

Usage

Create

let count = 0
//the generator are called with a arg and next, what is the next generator
let gen1 = function* ( arg, next ) {
  // every generator is evaluated with the arguments
  // passed when the event was emitted and the last
  // param is the next generator in the array listener
  // or handler event.
  count++
  // every generator is wrapper with co
  let res = yield Promise.resolve( 4 )
  assert.equal( res, 4 )
  //this statement pass the control flow to next generator in the array
  yield next
  assert.equal( arg, {a:3})
}

let gen2 = function* ( arg ) {
  // the last generator in the array not receive the
  // next generator.
  count++
  let res = yield Promise.resolve( '54' )
  assert.equal( res, '54' )
  assert.equal.deep( arg, {a:3} )
}
coEvent.on( 'test', gen1, gen2 ) // returns itself, you can pass as many generators as you need queue
coEvent.emit( 'test',{a:3}) // return a promise that is resolved when every generator is finish
// every error is catched and the promise is rejected with that error. Also error event is amitted when this
// error is catched
// every generator is called with arg={a:3}

assert.equal( count,2 )
// count is equal to generator number
// the emitter property is a EventEmitter instance self,
// where every method and property affect to CoEvent instance too.
// Also can use once method exposed to CoEvent to use generators wrapper
// with co.

let handler_1 = function * (arg){
    console.log(arg) // => 'hola'
    let res = yield Promise.resolve(2)
    console.log(this.a) // => 2
 
}

let handler_2 = function * (arg){
    console.log(arg) // => 'hola'
    let res = yield Promise.resolve(5)
    console.log(res) // => 5
    console.log(this.a) // => 2
}
// the wildcard are accepted, in this case the  events 'test::1', 'test::2' and 'test'
coEvent.on( 'test::1',handler_1 )
.on('test::2',handler_2)
.emit('test::*','hola')

Class Co-eventemitter

Co-eventemitter([thisArg])

To instance the co-eventemitter you can pass a thisArg object what will be passed to every generator as thisArg.

Instance Co-eventemitter

co-eventemitter.on(String,Generator[,Generator...])

This method added the Generators passed to event Handler of event given(String). Returns itself.

co-eventemitter.once(String,Generator[,Generator...])

This method added the Generators passed to event Handler of event given(String) to be emitted only one time. Returns itself.

co-eventemitter.emit(String,Object[,Object...])

This method emit the event event given(String) and pass every Object argument to every constructor. Returns a promise that is resolved when the every generator of event is finished or rejected if a error happen. If a error is through the error the promise is rejected and resolved in any other case.

co-eventemitter.emitter

Instance of EventEmitter, every change here affect to co-eventemitter instance.

co-eventemitter.events

Object where the keys are the events added and values are arrays with the listers generators to every event.

co-eventemitter.ctx

thisArg passed to every generator, this is the same passed to constructor and can be upgraded at any time.

Testing

Running the tests

npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. For any bugs report please contact to me via e-mail: cereceres@ciencias.unam.mx.

Licence

The MIT License (MIT)

Copyright (c) 2015 Jesús Edel Cereceres.

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.