npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

evenity

v1.0.0

Published

Unified event attachment and emit utility

Downloads

12

Readme

evenity

js-standard-style travis npm downloads

Unified event attachment utility

Features

  • Attach event to any kind of event-enabled object
  • Same event API for both node-like event emitter instance and html element
  • Return a closable object to detach event

Getting Started

Install the module with: npm install --save evenity

var evenity = require('evenity')
var EventEmitter = require('events').EventEmitter

var el = document.createElement('div')
var obj = new EventEmitter()

function handler(event) {
  // ...
  // event.detail contain the emitted datas
}

// Attach event on any eventemitter-kind object
var eventOnElement = evenity.on(el, 'myevent', handler)
var eventOnObject = evenity.on(obj, 'myevent', handler)

// Attach event once
evenity.once( /* ... */ )

// Detach event
evenity.off(el, 'myevent', handler)
evenity.off(obj, 'myevent', handler)

// Emit event
evenity.emit(el, 'click', {foo:'bar'})
//  {foo:'bar'} is the detail of the CustomEvent for HTMLElement

// Detach event using close method returned by evenity
eventOnElement.close()
eventOnObject.close()

API

evenity.on()

evenity.on({EventEmitter|HTMLElement} obj, {String} eventname, {Function} handler) => {Object} closable

Attach an event handler to an object. If obj is an HTMLElement the handler will receive an event object. Else, handler receive the emitted data.

The returned closable object has a closable.close() method to detach the handler:

var e = evenity.on(obj, 'eventname', function(event) { /* handle event.detail */ } )
e.close() // Detach event handler

evenity.once()

evenity.once({EventEmitter|HTMLElement} obj, {String} eventname, {Function} handler)

Same as evenity.on() but the handler is called only once, then the event is automatically detached

evenity.off()

evenity.off({EventEmitter|HTMLElement} obj, {String} eventname, {Function} handler)

Detach an event handler

evenity.emit()

evenity.emit({EventEmitter|HTMLElement} obj, {String|CustomEvent} eventnameOrCustomEvent, [{mixed|Event} data])

Emit an event. If obj is an HTMLElement, then a CustomEvent is emitted with data as detail. If data is a window.Event instance then

evenity.emit(el, 'myEvent', { foo: 'bar' })
evenity.emit(el, new CustomEvent('myEvent', { detail: {}, bubbles: true, cancelable: true }))
var canceled = !evenity.emit(el, new MouseEvent('click', { view: window, bubbles: true, cancelable: true }))

The MIT License

js-standard-style