flynx/guaranteeEvents
1
0
Fork 0
mirror of https://github.com/flynx/guaranteeEvents.git synced 2025-10-28 10:30:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

minor documentation changes...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2014-12-29 22:24:08 +03:00
parent e68fa30335
commit 93a5d86492
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -11,6 +11,9 @@ will provide the following functionality:
* Call new handlers of the specified event with each of the prior event
data sets in order of event occurrence.
* Add a `.clearGuaranteedQueue(<evetn>)` method to the emitter to facilitate
event cache cleaning.
This is useful for modules like [glob](https://github.com/isaacs/node-glob)
that use the [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter)
model to pass data to the user (see examples below).
@ -89,8 +92,9 @@ for all wrapped events.
So for the above example:
```javascript
// This this will drop all the prior matches, so newly registred handlers
// This this will drop all the prior match data, so newly registred handlers
// will not see them...
// NOTE: this will not affect the underlaying glob object in any way.
results.clearGuaranteedQueue('match')
```