diff --git a/README.md b/README.md index 7febbed..6c4d1ff 100644 --- a/README.md +++ b/README.md @@ -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()` 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') ```