Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 078cea8

Browse filesBrowse files
TrottMylesBorins
authored andcommitted
doc,events: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 9cddfe2 commit 078cea8
Copy full SHA for 078cea8

File tree

Expand file treeCollapse file tree

1 file changed

+20
-20
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+20
-20
lines changed
Open diff view settings
Collapse file

‎doc/api/events.md‎

Copy file name to clipboardExpand all lines: doc/api/events.md
+20-20Lines changed: 20 additions & 20 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ myEmitter.emit('error', new Error('whoops!'));
155155
// Prints: whoops! there was an error
156156
```
157157

158-
## Class: EventEmitter
158+
## Class: `EventEmitter`
159159
<!-- YAML
160160
added: v0.1.26
161161
-->
@@ -208,7 +208,7 @@ myEmitter.emit('event');
208208
// A
209209
```
210210

211-
### Event: 'removeListener'
211+
### Event: `'removeListener'`
212212
<!-- YAML
213213
added: v0.9.3
214214
changes:
@@ -223,7 +223,7 @@ changes:
223223

224224
The `'removeListener'` event is emitted *after* the `listener` is removed.
225225

226-
### EventEmitter.listenerCount(emitter, eventName)
226+
### `EventEmitter.listenerCount(emitter, eventName)`
227227
<!-- YAML
228228
added: v0.9.12
229229
deprecated: v4.0.0
@@ -245,7 +245,7 @@ console.log(EventEmitter.listenerCount(myEmitter, 'event'));
245245
// Prints: 2
246246
```
247247

248-
### EventEmitter.defaultMaxListeners
248+
### `EventEmitter.defaultMaxListeners`
249249
<!-- YAML
250250
added: v0.11.2
251251
-->
@@ -285,7 +285,7 @@ the event emitter instance, the event’s name and the number of attached
285285
listeners, respectively.
286286
Its `name` property is set to `'MaxListenersExceededWarning'`.
287287

288-
### emitter.addListener(eventName, listener)
288+
### `emitter.addListener(eventName, listener)`
289289
<!-- YAML
290290
added: v0.1.26
291291
-->
@@ -295,7 +295,7 @@ added: v0.1.26
295295

296296
Alias for `emitter.on(eventName, listener)`.
297297

298-
### emitter.emit(eventName\[, ...args\])
298+
### `emitter.emit(eventName[, ...args])`
299299
<!-- YAML
300300
added: v0.1.26
301301
-->
@@ -343,7 +343,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
343343
// event with parameters 1, 2, 3, 4, 5 in third listener
344344
```
345345

346-
### emitter.eventNames()
346+
### `emitter.eventNames()`
347347
<!-- YAML
348348
added: v6.0.0
349349
-->
@@ -366,7 +366,7 @@ console.log(myEE.eventNames());
366366
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
367367
```
368368

369-
### emitter.getMaxListeners()
369+
### `emitter.getMaxListeners()`
370370
<!-- YAML
371371
added: v1.0.0
372372
-->
@@ -377,7 +377,7 @@ Returns the current max listener value for the `EventEmitter` which is either
377377
set by [`emitter.setMaxListeners(n)`][] or defaults to
378378
[`EventEmitter.defaultMaxListeners`][].
379379

380-
### emitter.listenerCount(eventName)
380+
### `emitter.listenerCount(eventName)`
381381
<!-- YAML
382382
added: v3.2.0
383383
-->
@@ -387,7 +387,7 @@ added: v3.2.0
387387

388388
Returns the number of listeners listening to the event named `eventName`.
389389

390-
### emitter.listeners(eventName)
390+
### `emitter.listeners(eventName)`
391391
<!-- YAML
392392
added: v0.1.26
393393
changes:
@@ -410,7 +410,7 @@ console.log(util.inspect(server.listeners('connection')));
410410
// Prints: [ [Function] ]
411411
```
412412

413-
### emitter.off(eventName, listener)
413+
### `emitter.off(eventName, listener)`
414414
<!-- YAML
415415
added: v10.0.0
416416
-->
@@ -421,7 +421,7 @@ added: v10.0.0
421421

422422
Alias for [`emitter.removeListener()`][].
423423

424-
### emitter.on(eventName, listener)
424+
### `emitter.on(eventName, listener)`
425425
<!-- YAML
426426
added: v0.1.101
427427
-->
@@ -458,7 +458,7 @@ myEE.emit('foo');
458458
// a
459459
```
460460

461-
### emitter.once(eventName, listener)
461+
### `emitter.once(eventName, listener)`
462462
<!-- YAML
463463
added: v0.3.0
464464
-->
@@ -492,7 +492,7 @@ myEE.emit('foo');
492492
// a
493493
```
494494

495-
### emitter.prependListener(eventName, listener)
495+
### `emitter.prependListener(eventName, listener)`
496496
<!-- YAML
497497
added: v6.0.0
498498
-->
@@ -515,7 +515,7 @@ server.prependListener('connection', (stream) => {
515515

516516
Returns a reference to the `EventEmitter`, so that calls can be chained.
517517

518-
### emitter.prependOnceListener(eventName, listener)
518+
### `emitter.prependOnceListener(eventName, listener)`
519519
<!-- YAML
520520
added: v6.0.0
521521
-->
@@ -536,7 +536,7 @@ server.prependOnceListener('connection', (stream) => {
536536

537537
Returns a reference to the `EventEmitter`, so that calls can be chained.
538538

539-
### emitter.removeAllListeners(\[eventName\])
539+
### `emitter.removeAllListeners([eventName])`
540540
<!-- YAML
541541
added: v0.1.26
542542
-->
@@ -552,7 +552,7 @@ component or module (e.g. sockets or file streams).
552552

553553
Returns a reference to the `EventEmitter`, so that calls can be chained.
554554

555-
### emitter.removeListener(eventName, listener)
555+
### `emitter.removeListener(eventName, listener)`
556556
<!-- YAML
557557
added: v0.1.26
558558
-->
@@ -642,7 +642,7 @@ ee.emit('ping');
642642

643643
Returns a reference to the `EventEmitter`, so that calls can be chained.
644644

645-
### emitter.setMaxListeners(n)
645+
### `emitter.setMaxListeners(n)`
646646
<!-- YAML
647647
added: v0.3.5
648648
-->
@@ -659,7 +659,7 @@ to indicate an unlimited number of listeners.
659659

660660
Returns a reference to the `EventEmitter`, so that calls can be chained.
661661

662-
### emitter.rawListeners(eventName)
662+
### `emitter.rawListeners(eventName)`
663663
<!-- YAML
664664
added: v9.4.0
665665
-->
@@ -694,7 +694,7 @@ newListeners[0]();
694694
emitter.emit('log');
695695
```
696696

697-
## events.once(emitter, name)
697+
## `events.once(emitter, name)`
698698
<!-- YAML
699699
added: v11.13.0
700700
-->

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.