From 464363d3d077ac2e7566105a8ac75a46aba24a36 Mon Sep 17 00:00:00 2001 From: Alejandro Oviedo Date: Fri, 6 Nov 2015 11:00:16 -0300 Subject: [PATCH] doc: add method links in events.markdown MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added referenced method links. PR-URL: https://github.com/nodejs/node/pull/3187 Reviewed-By: Roman Reiss Reviewed-By: James M Snell Reviewed-By: Michaël Zasso --- doc/api/events.markdown | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/api/events.markdown b/doc/api/events.markdown index 543d263dc3d799..9dc384a850543f 100644 --- a/doc/api/events.markdown +++ b/doc/api/events.markdown @@ -4,8 +4,10 @@ -Many objects in Node.js emit events: a `net.Server` emits an event each time -a peer connects to it, a `fs.readStream` emits an event when the file is +Many objects in Node.js emit events: a +[`net.Server`](net.html#net_class_net_server) emits an event each time a peer +connects to it, a [`fs.ReadStream`](fs.html#fs_class_fs_readstream) emits an +event when the file is opened. All objects which emit events are instances of `events.EventEmitter`. You can access this module by doing: `require("events");` @@ -99,7 +101,8 @@ Returns emitter, so calls can be chained. ### emitter.getMaxListeners() Returns the current max listener value for the emitter which is either set by -`emitter.setMaxListeners(n)` or defaults to `EventEmitter.defaultMaxListeners`. +[`emitter.setMaxListeners(n)`](#events_emitter_setmaxlisteners_n) or defaults to +[`EventEmitter.defaultMaxListeners`](#events_eventemitter_defaultmaxlisteners). This can be useful to increment/decrement max listeners to avoid the warning while not being irresponsible and setting a too big number. @@ -112,12 +115,13 @@ while not being irresponsible and setting a too big number. ### EventEmitter.defaultMaxListeners -`emitter.setMaxListeners(n)` sets the maximum on a per-instance basis. +[`emitter.setMaxListeners(n)`](#events_emitter_setmaxlisteners_n) sets the +maximum on a per-instance basis. This class property lets you set it for *all* `EventEmitter` instances, current and future, effective immediately. Use with care. -Note that `emitter.setMaxListeners(n)` still has precedence over -`EventEmitter.defaultMaxListeners`. +Note that [`emitter.setMaxListeners(n)`](#events_emitter_setmaxlisteners_n) +still has precedence over `EventEmitter.defaultMaxListeners`. ### emitter.listeners(event)