FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,events: use code markup/markdown in headers · nodejs/node@db01d0f · GitHub

/ node Public

Commit db01d0f

Browse files
Trott
authored and
BridgeAR
committed
doc,events: use code markup/markdown in headers
PR-URL: #31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent fbb217a commit db01d0f

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

‎doc/api/events.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ The `'error'` events that are generated by the `captureRejections` behavior
220220
do not have a catch handler to avoid infinite error loops: the
221221
recommendation is to **not use `async` functions as `'error'` event handlers**.
222222

223-
## Class: EventEmitter
223+
## Class: `EventEmitter`
224224
<!-- YAML
225225
added: v0.1.26
226226
changes:
@@ -244,7 +244,7 @@ It supports the following option:
244244
[automatic capturing of promise rejection][capturerejections].
245245
Default: `false`.
246246

247-
### Event: 'newListener'
247+
### Event: `'newListener'`
248248
<!-- YAML
249249
added: v0.1.26
250250
-->
@@ -283,7 +283,7 @@ myEmitter.emit('event');
283283
// A
284284
```
285285

286-
### Event: 'removeListener'
286+
### Event: `'removeListener'`
287287
<!-- YAML
288288
added: v0.9.3
289289
changes:
@@ -298,7 +298,7 @@ changes:
298298

299299
The `'removeListener'` event is emitted *after* the `listener` is removed.
300300

301-
### EventEmitter.listenerCount(emitter, eventName)
301+
### `EventEmitter.listenerCount(emitter, eventName)`
302302
<!-- YAML
303303
added: v0.9.12
304304
deprecated: v4.0.0
@@ -320,7 +320,7 @@ console.log(EventEmitter.listenerCount(myEmitter, 'event'));
320320
// Prints: 2
321321
```
322322

323-
### EventEmitter.defaultMaxListeners
323+
### `EventEmitter.defaultMaxListeners`
324324
<!-- YAML
325325
added: v0.11.2
326326
-->
@@ -360,7 +360,7 @@ the event emitter instance, the event’s name and the number of attached
360360
listeners, respectively.
361361
Its `name` property is set to `'MaxListenersExceededWarning'`.
362362

363-
### EventEmitter.errorMonitor
363+
### `EventEmitter.errorMonitor`
364364
<!-- YAML
365365
added: REPLACEME
366366
-->
@@ -373,7 +373,7 @@ Installing a listener using this symbol does not change the behavior once an
373373
`'error'` event is emitted, therefore the process will still crash if no
374374
regular `'error'` listener is installed.
375375

376-
### emitter.addListener(eventName, listener)
376+
### `emitter.addListener(eventName, listener)`
377377
<!-- YAML
378378
added: v0.1.26
379379
-->
@@ -383,7 +383,7 @@ added: v0.1.26
383383

384384
Alias for `emitter.on(eventName, listener)`.
385385

386-
### emitter.emit(eventName\[, ...args\])
386+
### `emitter.emit(eventName[, ...args])`
387387
<!-- YAML
388388
added: v0.1.26
389389
-->
@@ -431,7 +431,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
431431
// event with parameters 1, 2, 3, 4, 5 in third listener
432432
```
433433

434-
### emitter.eventNames()
434+
### `emitter.eventNames()`
435435
<!-- YAML
436436
added: v6.0.0
437437
-->
@@ -454,7 +454,7 @@ console.log(myEE.eventNames());
454454
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
455455
```
456456

457-
### emitter.getMaxListeners()
457+
### `emitter.getMaxListeners()`
458458
<!-- YAML
459459
added: v1.0.0
460460
-->
@@ -465,7 +465,7 @@ Returns the current max listener value for the `EventEmitter` which is either
465465
set by [`emitter.setMaxListeners(n)`][] or defaults to
466466
[`EventEmitter.defaultMaxListeners`][].
467467

468-
### emitter.listenerCount(eventName)
468+
### `emitter.listenerCount(eventName)`
469469
<!-- YAML
470470
added: v3.2.0
471471
-->
@@ -475,7 +475,7 @@ added: v3.2.0
475475

476476
Returns the number of listeners listening to the event named `eventName`.
477477

478-
### emitter.listeners(eventName)
478+
### `emitter.listeners(eventName)`
479479
<!-- YAML
480480
added: v0.1.26
481481
changes:
@@ -498,7 +498,7 @@ console.log(util.inspect(server.listeners('connection')));
498498
// Prints: [ [Function] ]
499499
```
500500

501-
### emitter.off(eventName, listener)
501+
### `emitter.off(eventName, listener)`
502502
<!-- YAML
503503
added: v10.0.0
504504
-->
@@ -509,7 +509,7 @@ added: v10.0.0
509509

510510
Alias for [`emitter.removeListener()`][].
511511

512-
### emitter.on(eventName, listener)
512+
### `emitter.on(eventName, listener)`
513513
<!-- YAML
514514
added: v0.1.101
515515
-->
@@ -546,7 +546,7 @@ myEE.emit('foo');
546546
// a
547547
```
548548

549-
### emitter.once(eventName, listener)
549+
### `emitter.once(eventName, listener)`
550550
<!-- YAML
551551
added: v0.3.0
552552
-->
@@ -580,7 +580,7 @@ myEE.emit('foo');
580580
// a
581581
```
582582

583-
### emitter.prependListener(eventName, listener)
583+
### `emitter.prependListener(eventName, listener)`
584584
<!-- YAML
585585
added: v6.0.0
586586
-->
@@ -603,7 +603,7 @@ server.prependListener('connection', (stream) => {
603603

604604
Returns a reference to the `EventEmitter`, so that calls can be chained.
605605

606-
### emitter.prependOnceListener(eventName, listener)
606+
### `emitter.prependOnceListener(eventName, listener)`
607607
<!-- YAML
608608
added: v6.0.0
609609
-->
@@ -624,7 +624,7 @@ server.prependOnceListener('connection', (stream) => {
624624

625625
Returns a reference to the `EventEmitter`, so that calls can be chained.
626626

627-
### emitter.removeAllListeners(\[eventName\])
627+
### `emitter.removeAllListeners([eventName])`
628628
<!-- YAML
629629
added: v0.1.26
630630
-->
@@ -640,7 +640,7 @@ component or module (e.g. sockets or file streams).
640640

641641
Returns a reference to the `EventEmitter`, so that calls can be chained.
642642

643-
### emitter.removeListener(eventName, listener)
643+
### `emitter.removeListener(eventName, listener)`
644644
<!-- YAML
645645
added: v0.1.26
646646
-->
@@ -730,7 +730,7 @@ ee.emit('ping');
730730

731731
Returns a reference to the `EventEmitter`, so that calls can be chained.
732732

733-
### emitter.setMaxListeners(n)
733+
### `emitter.setMaxListeners(n)`
734734
<!-- YAML
735735
added: v0.3.5
736736
-->
@@ -747,7 +747,7 @@ to indicate an unlimited number of listeners.
747747

748748
Returns a reference to the `EventEmitter`, so that calls can be chained.
749749

750-
### emitter.rawListeners(eventName)
750+
### `emitter.rawListeners(eventName)`
751751
<!-- YAML
752752
added: v9.4.0
753753
-->
@@ -782,7 +782,7 @@ newListeners[0]();
782782
emitter.emit('log');
783783
```
784784

785-
### emitter\[Symbol.for('nodejs.rejection')\](err, eventName\[, ...args\])
785+
### `emitter[Symbol.for('nodejs.rejection')](err, eventName[, ...args])`
786786
<!-- YAML
787787
added: v13.4.0
788788
-->
@@ -818,7 +818,7 @@ class MyClass extends EventEmitter {
818818
}
819819
```
820820

821-
## events.once(emitter, name)
821+
## `events.once(emitter, name)`
822822
<!-- YAML
823823
added: v11.13.0
824824
-->
@@ -864,7 +864,7 @@ async function run() {
864864
run();
865865
```
866866

867-
## events.captureRejections
867+
## `events.captureRejections`
868868
<!-- YAML
869869
added: v13.4.0
870870
-->
@@ -875,7 +875,7 @@ Value: {boolean}
875875

876876
Change the default `captureRejections` option on all new `EventEmitter` objects.
877877

878-
## events.captureRejectionSymbol
878+
## `events.captureRejectionSymbol`
879879
<!-- YAML
880880
added: v13.4.0
881881
-->
@@ -886,7 +886,7 @@ Value: `Symbol.for('nodejs.rejection')`
886886

887887
See how to write a custom [rejection handler][rejection].
888888

889-
## events.on(emitter, eventName)
889+
## `events.on(emitter, eventName)`
890890
<!-- YAML
891891
added: REPLACEME
892892
-->

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL