events: make eventTarget.removeAllListeners() return this

Fixes: #35762 PR-URL: #35805 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
nodejs · Dec 15, 2020 · 8ef4557 · 8ef4557
1 parent 2984974
commit 8ef4557
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/doc/api/events.md b/doc/api/events.md
@@ -1451,6 +1451,8 @@ added: v14.5.0
 
 * `type` {string}
 
+* Returns: {EventTarget} this
+
 Node.js-specific extension to the `EventTarget` class. If `type` is specified,
 removes all registered listeners for `type`, otherwise removes all registered
 listeners.

diff --git a/lib/internal/event_target.js b/lib/internal/event_target.js
@@ -475,6 +475,8 @@ class NodeEventTarget extends EventTarget {
     } else {
       this[kEvents].clear();
     }
+
+    return this;
   }
 }
 

diff --git a/test/parallel/test-nodeeventtarget.js b/test/parallel/test-nodeeventtarget.js
@@ -117,11 +117,11 @@ const { on } = require('events');
   strictEqual(eventTarget.listenerCount('foo'), 2);
   strictEqual(eventTarget.listenerCount('bar'), 1);
   deepStrictEqual(eventTarget.eventNames(), ['foo', 'bar']);
-  eventTarget.removeAllListeners('foo');
+  strictEqual(eventTarget.removeAllListeners('foo'), eventTarget);
   strictEqual(eventTarget.listenerCount('foo'), 0);
   strictEqual(eventTarget.listenerCount('bar'), 1);
   deepStrictEqual(eventTarget.eventNames(), ['bar']);
-  eventTarget.removeAllListeners();
+  strictEqual(eventTarget.removeAllListeners(), eventTarget);
   strictEqual(eventTarget.listenerCount('foo'), 0);
   strictEqual(eventTarget.listenerCount('bar'), 0);
   deepStrictEqual(eventTarget.eventNames(), []);