Skip to content

Commit

Permalink
Added missing information to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mallocator committed Apr 20, 2016
1 parent c7d12ad commit bf4debc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ React as soon as all registered events have been fired at least once (and then r
arguments are overwritten, unless ```useFirst``` is set to true in which case the first argument is used and subsequent arguments are discarded.

```
var On = require('onall');
var emitter = new events.EventEmitter();
var on = new On(emitter);
on.all(['event1', 'event2'], args => {
Expand All @@ -47,6 +48,7 @@ React as soon as all registered events have been fired at least once (and then r
queue up events and not discard duplicate events.

```
var On = require('onall');
var emitter = new events.EventEmitter();
var on = new On(emitter);
on.allCached(['event1', 'event2'], args => {
Expand All @@ -69,6 +71,7 @@ Will react as soon as all events have been fired at least once and then no longe
subsequent events will be ignored.

```
var On = require('onall');
var emitter = new events.EventEmitter();
var on = new On(emitter);
on.allOnce(['event1', 'event2'], args => {
Expand All @@ -90,6 +93,7 @@ emitter.emit('event2', 'arg4');
Will react as soon as any of the given events are triggered.

```
var On = require('onall');
var emitter = new events.EventEmitter();
var on = new On(emitter);
on.any(['event1', 'event2'], (event, arg) => {
Expand All @@ -109,6 +113,7 @@ emitter.emit('event2', 'arg2');
Will react as soon as any of the given events are triggered, and then stop listening.

```
var On = require('onall');
var emitter = new events.EventEmitter();
var on = new On(emitter);
on.anyOnce(['event1', 'event2'], (event, arg) => {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onall",
"version": "1.0.0",
"version": "1.0.1",
"description": "A helper for the eventemitter that allows to only be fired when all events of a given type have been fired",
"main": "index.js",
"keywords": [
Expand Down

0 comments on commit bf4debc

Please sign in to comment.