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

event-listener-service

v1.0.1

Published

Universal Event Litener with testability built in

Downloads

590

Readme

event-listener-service

Universal Event Litener with testability built in

npm version license Build Status Code Climate Test Coverage Issue Count TypeScript Typings

Install

Install with npm:

$ npm install event-listener-service

NPM

Api

public static useWithoutImplementation(): void

Declare usage without internal event registering implementation

public static setImplementation(implementation: EventListenerImplementation): void

Set internal event registering implementation

public static addListener(eventName: string, listener: (event?: any) => void, ...additional: any[]): void

Add EventListener

public static emit(eventName: string, emitted?: any): void

Emit event using built in event emiting

public static removeListener(eventName: string, listener: (event?: any) => void, ...additional: any[]): void

Remove EventListener

Usage

As stand alone EventListener

import EventListenerService from 'event-listener-service';

// Declare usage without internal event registering implementation
EventListenerService.useWithoutImplementation();

function onSomeEvent(event) {
  console.log('some-event', event);
}

// Adding EventLisner
EventListenerService.addListener('some-event', onSomeEvent);

// Emiting Events 
EventListenerService.emit('some-event', { rand: 9 });

// Removing EventLisnter
EventListenerService.removeListener('some-event', onSomeEvent);

For listening events on DOM Nodes in the Browser

import EventListenerService from 'event-listener-service';

// Seting internal event registering implementation
EventListenerService.setImplementation({
    addListener: window.addEventListener.bind(window),
    removeListener: window.removeEventListener.bind(window)
});

function onResize() {
  /* ... */
}

// Adding EventLisner
EventListenerService.addListener('resize', onResize, false);

// Removing EventLisnter
EventListenerService.removeListener('resize', onResize, false);

// Optionaly you can manually trigger event listeners in your tests or when you need to fully simulate event 
EventListenerService.emit('resize', /* [event object] */);

As universal EventListener API


// Set internal implementation for registering event listeners

EventListenerService.setImplementation({
    addListener: /* (eventName: string, listener: (event?: any) => void, ...additional: any[]) => void */
    removeListener: /* (eventName: string, listener: (event?: any) => void, ...additional: any[]) => void */
});

// And than use addListener and removeListner

EventListnerService.addListener(eventName: string, listener: (event?: any) => void, ...additional: any[]);

EventListnerService.removeListener(eventName: string, listener: (event?: any) => void, ...additional: any[]);

Testing

  1. npm install

  2. npm test

Contributing

  1. npm install

  2. Make changes

  3. If necessary add some tests to __tests__

  4. npm test

  5. Make a Pull Request