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

@freshlysqueezedgames/emitter

v1.0.2

Published

Really simple base classes for creating an application in vanilla JavaScript

Downloads

3

Readme

Emitter Classes

Really simple base emitter class for creating an application in vanilla JavaScript, along with a singleton for passing event traffic globally between your subclasses.

Emitter

This simple class allows you to bind and call callbacks based on events that happen in your javascript application, it also provides a means of binding and casting a configuration object to allow for data-configured instances.

On

To add an event to an emitter, simply call it's "On" function, specifying the event name and a listener to be called when the event is fired.

  import Emitter from '@freshlysqueezedgames/emitter'

  const emitter : Emitter = new Emitter
  const payload : Object = {some : 'data'}

  const callback : Function = (payload : Object) => {
    console.log(payload : Object)
    // {some : 'data'}
  }

  emitter.On('test.event', callback)

The signature is:

  On (name : string, callback : Function, data? : number | boolean | string) : Emitter

The third parameter allows you to define circumstances for the events removal. A number will be a counter which removes the event once it has been called the same number of times, a boolean of true will remove it after firing once, a string allows an identifier to be used with the function, so you don't have to hold a reference to the callback to remove it later on.

Off

To remove a listener, call this function.

  emitter.Off('test.event', callback) : Emitter

The signature for Off is:

   Off (name : string, identifier? : Function | string) : Emitter

If you provide no arguments, the emitter will remove ALL its event listeners. Calling just the name will remove all listeners for that event, using an identifier string or the original callback will remove only that member.

Emit

Emit is responsible for delivering a payload of data to all listeners for a specific event

  emitter.Emit('test.event', {some : 'data'})

The above will notify all listeners to 'test.event' that it has happened, and deliver the data.

Set

Another feature of the Emitter base class is all properties in a given config object will be applied and type-cast to the instance. This can be useful when taking JSON data that might not necessarily have the right types on the data. If it is parsed XML you are using they will all be strings.

The Set function is seperated for inheritance reasons. In the latest versions of JS super() must be called before referencing the instance properties. Therefore, when you apply default values, Set must be called again to apply the config object correctly.

Example:


   class Test extends Emitter {
     constructor(props? : Object) {
       super(props)

       const t : Test = this

       t.number = 0 // set your default

       t.Set(props) // the configuration value will be applied as a number, regardless of its type.
     }
   }

Signature is:


   Set (props : Object) : Emitter

Chaining

Note that all the functions for Emitter return the instance, so function calls can be chained.

Message

This is a global singleton that can be used to register and deregister events in the system. It is an extension of Emitter, with some additional logic to make it the main event passing singleton for your application. In reality, it is just a global Emitter that exists as a singleton.


const message : Message = Message.Instance() // Calling using the Instance method will instantiate an instance if none exists
const emitter : Emitter = new Emitter

message.Watch('test.event', emitter)
message.On('test.event', () => console.log('event was fired via message'))

The above may seem simple, but we have a single endpoint that can listen for events, that can be passed back anywhere else in the object heap. So basically on object doesn't have to reference another in order to get events from it.

Watch

The signature is:


Watch (name : string, callback : Function, data? : number | boolean | string)

As with Emitter's On method, you can dictate the number of calls or the identifier string as the optional third parameter.