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

documented the .clearGuaranteedQueue(..) method...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2014-12-29 22:19:49 +03:00
parent af131afe2f
commit e02f6f3742
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -74,3 +74,24 @@ results.on('match', function(path){ console.log('found: '+path) })
```
Cache cleaning and use for long running emitters
------------------------------------------------
This is not recommended for use in long running event emitters as each
event emitted data will get stored and might get quite large, i.e. a
potential source for a leak.
To deal with this issue a `.clearGuaranteedQueue(<event>)` method is
added to the emitter, this will clear the cache for a specific event and
a shorthand form `.clearGuaranteedQueue('*')` that will clear the cache
for all wrapped events.
So for the above example:
```javascript
// This this will drop all the prior matches, so newly registred handlers
// will not see them...
results.clearGuaranteedQueue('match')
```