From 93a5d86492debc2a9b6c712a59c16a17b747948c Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Mon, 29 Dec 2014 22:24:08 +0300 Subject: [PATCH] minor documentation changes... Signed-off-by: Alex A. Naanou --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) 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') ```