adirelle/react-event-promise

Create promises of event.

dev-master 2015-07-12 05:43 UTC

Requires

• php: >=5.4
• evenement/evenement: ^2.0
• react/promise: ^2.2

Requires (Dev)

• phpunit/phpunit: ^4.7

MIT

• Adirelle

README

EventPromise allows you to easily create Promises that react on events emitted by an EventEmitterInterface.

Listeners are automatically removed when the Promise is fulfilled, rejected or cancelled.

Fetch

The recommended way to install EventPromise is through composer.

Just create a composer.json file for your project:

{
    "require": {
        "adirelle/react-event-promise": "@stable"
    }
}

API

Promises are created using the Adirelle\React\EventPromise\EventPromise::listen method:

use \Adirelle\React\EventPromise\EventPromise;
// ...

    EventPromise::listen($someEventEmitter, ['eventToResolve'], ['eventToReject'], ['eventToNotify'])
        ->then(
            function ($arguments) {
                echo 'Event "eventToResolve" emitted';
            },
            function ($arguments) {
                echo 'Event "eventToReject" emitted';
            },
            function ($arguments) {
                echo 'Event "eventToNotify" emitted';
            }
        );

License

EventPromise is released under the MIT license.