Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

events: add/removeListener should call on/off #29503

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,10 @@ added: v0.1.26
-->
* `eventName` {string|symbol}
* `listener` {Function}
* Returns: {EventEmitter}

Alias for `emitter.on(eventName, listener)`.
This function is implemented by calling [`emitter.on()`][].
When overriding, override [`emitter.on()`][].

### emitter.emit(eventName[, ...args])
<!-- YAML
Expand Down Expand Up @@ -415,7 +417,8 @@ added: v10.0.0
* `listener` {Function}
* Returns: {EventEmitter}

Alias for [`emitter.removeListener()`][].
This function is implemented by calling [`emitter.removeListener()`][].
When overriding, override [`emitter.removeListener()`][].

### emitter.on(eventName, listener)
<!-- YAML
Expand Down
2 changes: 0 additions & 2 deletions lib/_http_server.js
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,6 @@ function connectionListenerInternal(server, socket) {

// Overrides to unconsume on `data`, `readable` listeners
socket.on = generateSocketListenerWrapper('on');
socket.addListener = generateSocketListenerWrapper('addListener');
socket.prependListener = generateSocketListenerWrapper('prependListener');

// We only consume the socket if it has never been consumed before.
Expand Down Expand Up @@ -792,7 +791,6 @@ function generateSocketListenerWrapper(originalFnName) {
const res = net.Socket.prototype[originalFnName].call(this, ev, fn);
if (!this.parser) {
this.on = net.Socket.prototype.on;
this.addListener = net.Socket.prototype.addListener;
this.prependListener = net.Socket.prototype.prependListener;
return res;
}
Expand Down
1 change: 0 additions & 1 deletion lib/_stream_readable.js
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,6 @@ Readable.prototype.on = function(ev, fn) {

return res;
};
Readable.prototype.addListener = Readable.prototype.on;

Readable.prototype.removeListener = function(ev, fn) {
const res = Stream.prototype.removeListener.call(this, ev, fn);
Expand Down
11 changes: 8 additions & 3 deletions lib/events.js
Original file line number Diff line number Diff line change
Expand Up @@ -280,10 +280,12 @@ function _addListener(target, type, listener, prepend) {
}

EventEmitter.prototype.addListener = function addListener(type, listener) {
return _addListener(this, type, listener, false);
return this.on(type, listener);
};

EventEmitter.prototype.on = EventEmitter.prototype.addListener;
EventEmitter.prototype.on = function on(type, listener) {
return _addListener(this, type, listener, false);
};

EventEmitter.prototype.prependListener =
function prependListener(type, listener) {
Expand Down Expand Up @@ -378,7 +380,10 @@ EventEmitter.prototype.removeListener =
return this;
};

EventEmitter.prototype.off = EventEmitter.prototype.removeListener;
EventEmitter.prototype.off =
function off(type, listener) {
return this.removeListener(type, listener);
};

EventEmitter.prototype.removeAllListeners =
function removeAllListeners(type) {
Expand Down
3 changes: 0 additions & 3 deletions test/parallel/test-event-emitter-add-listeners.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ const EventEmitter = require('events');
const events_new_listener_emitted = [];
const listeners_new_listener_emitted = [];

// Sanity check
assert.strictEqual(ee.addListener, ee.on);

ee.on('newListener', function(event, listener) {
// Don't track newListener listeners.
if (event === 'newListener')
Expand Down
5 changes: 2 additions & 3 deletions test/parallel/test-event-emitter-method-names.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ const events = require('events');

const E = events.EventEmitter.prototype;
assert.strictEqual(E.constructor.name, 'EventEmitter');
assert.strictEqual(E.on, E.addListener); // Same method.
assert.strictEqual(E.off, E.removeListener); // Same method.

Object.getOwnPropertyNames(E).forEach(function(name) {
if (name === 'constructor' || name === 'on' || name === 'off') return;
if (name === 'constructor') return;
if (typeof E[name] !== 'function') return;
assert.strictEqual(E[name].name, name);
});
16 changes: 16 additions & 0 deletions test/parallel/test-events-override.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
'use strict';

const common = require('../common');
const { EventEmitter: EE } = require('events');

{
const e = new EE();
e.on = common.mustCall();
e.addListener('test', () => {});
}

{
const e = new EE();
e.removeListener = common.mustCall();
e.off('test', () => {});
}