on

Do you like to use anonymous functions with event handlers, but get annoyed when you have to remove those event handlers later? Yeah? Then this module is for you!

Consider the following:

buttonEl.addEventListener('click', (e) => {
  alert('Click!');
});

If you wanted to remove this handler later, you'd need a function reference:

function onButtonClick(e) {
  alert('Click!');
}

buttonEl.addEventListener('click', onButtonClick);

// Then, to remove:
buttonEl.removeEventListener('click', onButtonClick);

If you have a bunch of these, or if you don't like having function references inside of function references inside of function references, maybe you could use a different method.

This module adds your event listener and returns a function bound to the appropriate removeEventListener call, all in one go. For example:

const remover = on(buttonEl, 'click', (e) => {
  alert('Click!');
});

// Then, to remove:
remover();

Simple!

Installation

npm install @audiopump/on

Usage

import on from 'on';

License

Copyright (c) 2022 AudioPump, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.