summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavidCai <davidcai1993@yahoo.com>2017-03-21 08:18:33 +0800
committerJames M Snell <jasnell@gmail.com>2017-03-22 13:59:45 -0700
commit221b03ad20453f08cef7ac3fcc788b8466edc3ef (patch)
treecf69903370ae5b4d81fb1f05ae2cc4b705d25150 /doc
parent81ab78e62e2406eb2c4266866d2b8d28455dc59a (diff)
downloadandroid-node-v8-221b03ad20453f08cef7ac3fcc788b8466edc3ef.tar.gz
android-node-v8-221b03ad20453f08cef7ac3fcc788b8466edc3ef.tar.bz2
android-node-v8-221b03ad20453f08cef7ac3fcc788b8466edc3ef.zip
events, doc: check input in defaultMaxListeners
PR-URL: https://github.com/nodejs/node/pull/11938 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Brian White <mscdex@mscdex.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/events.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/events.md b/doc/api/events.md
index 5c0614b68b..cb3ac491dc 100644
--- a/doc/api/events.md
+++ b/doc/api/events.md
@@ -262,7 +262,8 @@ By default, a maximum of `10` listeners can be registered for any single
event. This limit can be changed for individual `EventEmitter` instances
using the [`emitter.setMaxListeners(n)`][] method. To change the default
for *all* `EventEmitter` instances, the `EventEmitter.defaultMaxListeners`
-property can be used.
+property can be used. If this value is not a positive number, a `TypeError`
+will be thrown.
Take caution when setting the `EventEmitter.defaultMaxListeners` because the
change effects *all* `EventEmitter` instances, including those created before