Set event listeners in ES6 class definition that extends EventEmitter
Asked Answered
T

2

9

I want some predefined custom listeners, that are defined already with the definition of the class (like the build in 'newListner' event). So I don't want to just bind them in the constructor because it would be executed on every new instance of that class.

How to do this? Modify the prototype? Is it possible at all?

What I have so far:

class Cat extends EventEmitter {
  // just added for demonstration, I don't want this!
  constructor() {
    super();
    // does fire
    this.on('wave', function() { console.log('constructor wave'); });
  }
}
// compiles but does not fire
Cat.prototype.on('wave', function() { console.log('prototype wave'); });

var cat = new Cat();
cat.emit('wave');
Trumpeter answered 4/3, 2016 at 13:4 Comment(4)
The constructor is part of the class definition? This doesn't really make sense. Only instances can have listeners and fire events, so this is really the only way - register them for every instance.Dionedionis
@Dionedionis Was a bit misleading, moved and changed the comment. The constructor is of course not part of the definition, that is why I don't want it.Trumpeter
What constitutes a "class definition" then for you, if not the class declaration that contains the constructor?Dionedionis
@Dionedionis With class definition I mean everything that is already there before the constructor is called, that is "executed" only once (at definition time) and not with every new instance. In other languages that could be class properties. ES6 does not have them, so I wondered if there is any other solution or if I missed something.Trumpeter
D
9

You cannot avoid registering the listeners separately for every instance, and the natural place to do that is in the constructor1, 2. However, you can avoid creating new listener functions:

class Cat extends EventEmitter {
  constructor() {
    super();
    this.on('wave', this.onWave);
  }
  onWave() {
    console.log('prototype wave');
  }
}

var cat = new Cat();
cat.emit('wave');

1: There are other ways, like a getter for ._events. You could do all kinds of fancy stuff with that, including prototypical inheritance for "default" listeners, but those are totally overcomplicated and get over your head quickly. You can do fancy things as well - and much cleaner - by just putting some generic code in the constructor.
2: You could also override (specialise) the init method of EventEmitters, but it comes down to exactly the same.

Dionedionis answered 4/3, 2016 at 13:32 Comment(0)
K
0

Since, as far as I can see, multiple instances of the Cat emitter can't communicate with each other, you will have to register the listener for each instance in the constructor:

class Cat extends EventEmitter {
  constructor() {
    super();
    this.on('wave', function() { console.log('constructor wave'); });
  }
}

var cat = new Cat();
cat.emit('wave');

You can then always share your emitter instance throughout different files by requireing it into the scripts you need it in.

Kreis answered 4/3, 2016 at 13:30 Comment(4)
Cat.prototype is instanceof EvenEmitter, and you could theoretically do Cat.prototype.emit('wave'), but you're right that it doesn't make any sense.Dionedionis
Thank you for clarifying. Cat.prototype.emit('wave') doesn't seem to work, so I assumed there are things happening in the EventEmitter constructor that are necessary for it to work (which is only called when a new Cat intance is created). Is that correct?Kreis
Last time I checked it was not necessary to invoke the constructor (but the best practise, of course), on and emit calls would initialise the object themselves if it hasn't happened yet.Dionedionis
Thank you, that makes sense.Kreis

© 2022 - 2024 — McMap. All rights reserved.