eventcache
v0.1.6
Published
This small module aims to simplify the binding and unbinding of event listeners by creating distinct event caches.
Downloads
3
Readme
EventCache
An event support system written in JavaScript. This small module aims to simplify the binding
and unbinding of event listeners by creating distinct event caches.
The system tries to use the "addEventListener" style of binding listeners and can
therefore be used wherever this pattern applies. It falls back to "attachEvent" and "on+event" as a last resort.
Installation
This module can be used directly in the browser:
<script src="/js/eventcache.min.js"></script>
You can also install it with npm.
$ npm install eventcache
Usage
import * as EventCache from "eventcache";
var myCache, signature;
// A custom listener function.
function listener() {}
// Create an event listener and store it in the default cache.
EventCache.bind(window, "load", listener);
// Create your own event cache.
myCache = EventCache.createCache();
// Create an event listener and store it in the specified cache.
signature = EventCache.bind(window, "load", listener, myCache);
// Unbinds the listener and removes it from its cache.
EventCache.unbind(signature);
// Flushes your cache.
EventCache.flush(myCache);
// Flushes the default cache.
// Listeners inside the default cache are supposed to live long, though!
EventCache.flush(0);
// Flushes all caches and deletes them. (The default one always remains).
EventCache.flush();
Hint
In order to prevent event listener memory leaks in certain browsers, you can just include the following line in your code:
EventCache.bind(window, "unload", EventCache.flush);
Documentation
Contributing
Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
License
Copyright (c) 2015 Raoul van Rüschen
Licensed under the Zlib license.