Commit b14d9c5
doc: add method links in events.markdown
Added referenced method links.
PR-URL: #3187
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>1 parent 44f779b commit b14d9c5
1 file changed
Lines changed: 10 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4,8 +4,10 @@ | |||
| 4 | 4 | ||
| 5 | 5 | <!--type=module--> | |
| 6 | 6 | ||
| 7 | - Many objects in Node.js emit events: a `net.Server` emits an event each time | ||
| 8 | - a peer connects to it, a `fs.readStream` emits an event when the file is | ||
| 7 | + Many objects in Node.js emit events: a | ||
| 8 | + [`net.Server`](net.html#net_class_net_server) emits an event each time a peer | ||
| 9 | + connects to it, a [`fs.ReadStream`](fs.html#fs_class_fs_readstream) emits an | ||
| 10 | + event when the file is | ||
| 9 | 11 | opened. All objects which emit events are instances of `events.EventEmitter`. | |
| 10 | 12 | You can access this module by doing: `require("events");` | |
| 11 | 13 | ||
@@ -99,7 +101,8 @@ Returns emitter, so calls can be chained. | |||
| 99 | 101 | ### emitter.getMaxListeners() | |
| 100 | 102 | ||
| 101 | 103 | Returns the current max listener value for the emitter which is either set by | |
| 102 | - `emitter.setMaxListeners(n)` or defaults to `EventEmitter.defaultMaxListeners`. | ||
| 104 | + [`emitter.setMaxListeners(n)`](#events_emitter_setmaxlisteners_n) or defaults to | ||
| 105 | + [`EventEmitter.defaultMaxListeners`](#events_eventemitter_defaultmaxlisteners). | ||
| 103 | 106 | ||
| 104 | 107 | This can be useful to increment/decrement max listeners to avoid the warning | |
| 105 | 108 | while not being irresponsible and setting a too big number. | |
@@ -112,12 +115,13 @@ while not being irresponsible and setting a too big number. | |||
| 112 | 115 | ||
| 113 | 116 | ### EventEmitter.defaultMaxListeners | |
| 114 | 117 | ||
| 115 | - `emitter.setMaxListeners(n)` sets the maximum on a per-instance basis. | ||
| 118 | + [`emitter.setMaxListeners(n)`](#events_emitter_setmaxlisteners_n) sets the | ||
| 119 | + maximum on a per-instance basis. | ||
| 116 | 120 | This class property lets you set it for *all* `EventEmitter` instances, | |
| 117 | 121 | current and future, effective immediately. Use with care. | |
| 118 | 122 | ||
| 119 | - Note that `emitter.setMaxListeners(n)` still has precedence over | ||
| 120 | - `EventEmitter.defaultMaxListeners`. | ||
| 123 | + Note that [`emitter.setMaxListeners(n)`](#events_emitter_setmaxlisteners_n) | ||
| 124 | + still has precedence over `EventEmitter.defaultMaxListeners`. | ||
| 121 | 125 | ||
| 122 | 126 | ||
| 123 | 127 | ### emitter.listeners(event) | |
0 commit comments