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-js

v0.1.3

Published

A simple class for allowing c# style events (with some extra features) in js

Downloads

1,704

Readme

EventHandler

Build Status

A simple class for allowing c# style events in js:

function SomeClass()
{
    this.someEvent = new EventJs.EventHandler(this);
    this.publishEvent = function() { this.someEvent.publish("hello"); }
}

var someInstance = new SomeClass();
someInstance.someEvent.subscribe(function(args, sender) { alert(args); });
someInstance.publishEvent();
// Would alert "hello"

Installation

IF you are using Node then you should be able to just do:

var EventHandler = require("event-handler");

If you want to use it in the browser without a module loader then grab the event.js file in dist/browser it will self register the EventJs global for you to access the event handler.

var EventHandler = EventJs.EventHandler;

Either way you will need to new up an instance of it to use it.

var someEvent = new EventHandler(theSenderGoesHere);

Usage

So as shown in the above example you can easily subscribe to events with it, subscribe as many listeners as you want to them.

var function1 = function(args, sender) { ... };
var function2 = function(args, sender) { ... };
var function3 = function(args, sender) { ... };

var someEvent = new EventHandler(someSender);

someEvent.subscribe(function1);
someEvent.subscribe(function2);
someEvent.subscribe(function3);

someEvent.publish(something);

You can also add predicates to only subscribe based upon arguments:

var onlyWhenPredicateMet = function(args) { ... };
var predicate = function(args) { return args.length <= 2; }

var someEvent = new EventHandler(someSender);

someEvent.subscribe(onlyWhenPredicateMet, predicate);

someEvent.publish("too long"); // subscription wont get triggered
someEvent.publish("GO"); // predicate returns true and would trigger subscription

Finally if you want to unsubscribe just do:

var someSubscription = function(args) { ... };
var someEvent = new EventHandler(someSender);

someEvent.subscribe(someSubscription); // subscribe it
someEvent.unsubscribe(someSubscription); // unsubscribe it

or if you are living dangerously and end up doing a lot of inline functions you can capture the return unsubscriber token and use that for unsubscribing:

var someSubscription = ;
var someEvent = new EventHandler(someSender);

var unsubscriber = someEvent.subscribe(function(args) { ... }); // subscribe and get unsubscriber
unsubscriber(); // unsubscribe it

Differences with C#

In c# the events tend to put the sender first, however as in most cases you don't care about the sender and JS has optional arguments it made more sense for the args to be the first parameter and then the sender be the last, this makes it more succinct when writing event handlers which do not care about the sender.

Before version 0.0.6 it used to be the other way around, but from this point on it will be as detailed above.