Skip to content

Commit c9b202f

Browse files
AjidoMylesBorins
authored andcommitted
doc: add emitter.off() to events.md
PR-URL: #20291 Refs: #17156 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent b5bc6bd commit c9b202f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/api/events.md

+12
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,17 @@ console.log(util.inspect(server.listeners('connection')));
372372
// Prints: [ [Function] ]
373373
```
374374

375+
### emitter.off(eventName, listener)
376+
<!-- YAML
377+
added: v10.0.0
378+
-->
379+
380+
* `eventName` {string|symbol}
381+
* `listener` {Function}
382+
* Returns: {EventEmitter}
383+
384+
Alias for [`emitter.removeListener()`][].
385+
375386
### emitter.on(eventName, listener)
376387
<!-- YAML
377388
added: v0.1.101
@@ -626,6 +637,7 @@ emitter.emit('log');
626637
[`EventEmitter.defaultMaxListeners`]: #events_eventemitter_defaultmaxlisteners
627638
[`domain`]: domain.html
628639
[`emitter.listenerCount()`]: #events_emitter_listenercount_eventname
640+
[`emitter.removeListener()`]: #events_emitter_removelistener_eventname_listener
629641
[`emitter.setMaxListeners(n)`]: #events_emitter_setmaxlisteners_n
630642
[`fs.ReadStream`]: fs.html#fs_class_fs_readstream
631643
[`net.Server`]: net.html#net_class_net_server

0 commit comments

Comments
 (0)