Skip to content

A generic Node.js style event handler as a class property

License

Notifications You must be signed in to change notification settings

bcomnes/node-event-handler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-event-handler

npm version build status coverage downloads js-standard-style

A generic Node.js style event handler.

Installation

$ npm install node-event-handler

Usage

const NodeEventHandler = require('node-event-handler')
const WebSocket = require('ws')

class MyWSController extends SomeOtherClass {
  constructor () {
    this.ws = new WebSocket('ws://localhost:8080')
    this.handler = new NodeEventHandler(this, this.ws)
  }

  // These methods handle the websocket events
  onmessage (data) {}
  onopen () {}
  onerror (error) {}
  onclose () {}
}

API

handler = new NodeEventHandler(ctx, [ee])

Create a new instance of NodeEventHandler passing in a context ctx (often this when created within a class) and optionally a Node.js style event emitter ee to attach listeners to on instantiation.

The ctx should be an object who's prototype contains event handler methods. Event handler methods must take the form of on${eventname} where eventname is the name of the event you want to listen on and handle (the name you would pass to ee.on(eventname)). In practice, you can pass a class instance as a ctx, or this when the instance owns the NodeEventHanlder instance.

handler.addEventListeners(ee)

Attach all event handler methods on ctx to the Node.js style event emitter ee.

handler.removeEventListeners(ee)

Remove all event handler event names on ctx from the Node.js style event emitter ee.

See also

This module is an API match to dom-event-handler which has a clever API, but requires the support of the handleEvent on the EventListener interface. Most Node.js modules have poor support for these interfaces because they are difficult to replicate outside of a browser.

When using dom-event-handler in a universal context, this can be used as a stand-in on the Node.js side of things.

License

MIT