summaryrefslogtreecommitdiff
path: root/doc/api/events.md
diff options
context:
space:
mode:
authorAjido <ajido@me.com>2018-04-25 23:46:54 +0900
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-25 19:55:53 +0300
commit1e40b75404872c45961cff33376f1d85ead73165 (patch)
tree206891e2e61a2e8a7b297c786d813e46021e5e8d /doc/api/events.md
parent9d35f696e86289843de7d1ea2a586070984efbba (diff)
downloadnode-new-1e40b75404872c45961cff33376f1d85ead73165.tar.gz
doc: add emitter.off() to events.md
PR-URL: https://github.com/nodejs/node/pull/20291 Refs: https://github.com/nodejs/node/pull/17156 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api/events.md')
-rw-r--r--doc/api/events.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/events.md b/doc/api/events.md
index a5a45ca3de..35ad9eaed3 100644
--- a/doc/api/events.md
+++ b/doc/api/events.md
@@ -372,6 +372,17 @@ console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
```
+### emitter.off(eventName, listener)
+<!-- YAML
+added: v10.0.0
+-->
+
+* `eventName` {string|symbol}
+* `listener` {Function}
+* Returns: {EventEmitter}
+
+Alias for [`emitter.removeListener()`][].
+
### emitter.on(eventName, listener)
<!-- YAML
added: v0.1.101
@@ -626,6 +637,7 @@ emitter.emit('log');
[`EventEmitter.defaultMaxListeners`]: #events_eventemitter_defaultmaxlisteners
[`domain`]: domain.html
[`emitter.listenerCount()`]: #events_emitter_listenercount_eventname
+[`emitter.removeListener()`]: #events_emitter_removelistener_eventname_listener
[`emitter.setMaxListeners(n)`]: #events_emitter_setmaxlisteners_n
[`fs.ReadStream`]: fs.html#fs_class_fs_readstream
[`net.Server`]: net.html#net_class_net_server