Giter VIP home page Giter VIP logo

chained-emitter's Introduction

DEPRECATED

This package is deprecated. EventEmitter2 added support for promises with its emitAsync function.

ChainedEventEmitter

ChainedEventEmitter is a an implementation of the EventEmitter found in Node.js, based on EventEmitter2, but adding the ability to return a promise in an event handler, so that the next handler waits for the previous to finish before firing. As well, emit() returns a promise that is fulfilled when all of the handlers have fired.

Features

  • Everything from EventEmitter2
  • Event chains

Differences (Non breaking, compatible with existing EventEmitter, EventEmitter2)

  • The constructor takes a configuration object.
    var ChainedEmitter = require('ChainedEmitter').EventEmitter;
    var server = new ChainedEmitter({
      parallel: true, // fire second handler before the first resolves, defaults to false
    });
  • Returning a promise
    var bb = require('bluebird')
    server.on('foo.*', function(value1, value2) {
      return bb.defer().promise
    });

API

emitter.addListener(event, listener)

emitter.on(event, listener)

Adds a listener to the end of the listeners array for the specified event. If the listener returns a bluebird promise, the promise returned by emit() will not resolve until the returned promise resolves. If the parallel configuration is false, the next handler will also wait to fire before the returned promise resolves. If you return anything but a promise (including undefined or null), the next action will happen immediately.

    server.on('data', function(value1, value2, value3 /* accepts any number of expected values... */) {
      var me = bb.defer();
      return me.promise; // wait for me!
    });
    server.on('data', function(value) {
      return; // don't wait!
    });

Licence

(The MIT License)

Copyright (c) 2011 hij1nx http://www.twitter.com/hij1nx
Copyright (c) 2013 hildjj http://www.twitter.com/hildjj

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.

chained-emitter's People

Contributors

adrai avatar andrewjstone avatar andreyvit avatar eventualbuddha avatar fuguenation avatar heapwolf avatar hildjj avatar indexzero avatar indutny avatar jamesonjlee avatar jaycetde avatar jvduf avatar kadirpekel avatar ksdlck avatar marsup avatar mmalecki avatar pwellner avatar robertjustjones avatar rwaldron avatar sergeyksv avatar shaunc avatar tauren avatar temsa avatar tommedema avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

chained-emitter's Issues

Merge with upstream

I haven't been tracking upstream, and now the merge is looking tough. I think the right approach is to capture the changes on ChainedEmitter.js, reset to upstream, then carefully apply the changes.

fix "many" (and once) to return promise

thank you for creating this module!

however, as much as i would dearly love to use it, the lack of support for once is a show-stopper

@shaunc has been generous in providing #5 which addresses this issue. it would be great to see that merged and released

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.