From c4c10d1c090e71c8caa66ce12e007fd6bfc2a261 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 23 Dec 2019 21:35:16 -0800 Subject: [PATCH] doc,events: use code markup/markdown in headers Backport-PR-URL: https://github.com/nodejs/node/pull/31108 PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen Reviewed-By: Ruben Bridgewater --- doc/api/events.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index ec6f608609073f..a2f9fe05ef119e 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -155,7 +155,7 @@ myEmitter.emit('error', new Error('whoops!')); // Prints: whoops! there was an error ``` -## Class: EventEmitter +## Class: `EventEmitter` @@ -208,7 +208,7 @@ myEmitter.emit('event'); // A ``` -### Event: 'removeListener' +### Event: `'removeListener'` @@ -285,7 +285,7 @@ the event emitter instance, the event’s name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`. -### emitter.addListener(eventName, listener) +### `emitter.addListener(eventName, listener)` @@ -295,7 +295,7 @@ added: v0.1.26 Alias for `emitter.on(eventName, listener)`. -### emitter.emit(eventName\[, ...args\]) +### `emitter.emit(eventName[, ...args])` @@ -343,7 +343,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); // event with parameters 1, 2, 3, 4, 5 in third listener ``` -### emitter.eventNames() +### `emitter.eventNames()` @@ -366,7 +366,7 @@ console.log(myEE.eventNames()); // Prints: [ 'foo', 'bar', Symbol(symbol) ] ``` -### emitter.getMaxListeners() +### `emitter.getMaxListeners()` @@ -377,7 +377,7 @@ Returns the current max listener value for the `EventEmitter` which is either set by [`emitter.setMaxListeners(n)`][] or defaults to [`EventEmitter.defaultMaxListeners`][]. -### emitter.listenerCount(eventName) +### `emitter.listenerCount(eventName)` @@ -387,7 +387,7 @@ added: v3.2.0 Returns the number of listeners listening to the event named `eventName`. -### emitter.listeners(eventName) +### `emitter.listeners(eventName)` @@ -421,7 +421,7 @@ added: v10.0.0 Alias for [`emitter.removeListener()`][]. -### emitter.on(eventName, listener) +### `emitter.on(eventName, listener)` @@ -458,7 +458,7 @@ myEE.emit('foo'); // a ``` -### emitter.once(eventName, listener) +### `emitter.once(eventName, listener)` @@ -492,7 +492,7 @@ myEE.emit('foo'); // a ``` -### emitter.prependListener(eventName, listener) +### `emitter.prependListener(eventName, listener)` @@ -515,7 +515,7 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -### emitter.prependOnceListener(eventName, listener) +### `emitter.prependOnceListener(eventName, listener)` @@ -536,7 +536,7 @@ server.prependOnceListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -### emitter.removeAllListeners(\[eventName\]) +### `emitter.removeAllListeners([eventName])` @@ -552,7 +552,7 @@ component or module (e.g. sockets or file streams). Returns a reference to the `EventEmitter`, so that calls can be chained. -### emitter.removeListener(eventName, listener) +### `emitter.removeListener(eventName, listener)` @@ -642,7 +642,7 @@ ee.emit('ping'); Returns a reference to the `EventEmitter`, so that calls can be chained. -### emitter.setMaxListeners(n) +### `emitter.setMaxListeners(n)` @@ -659,7 +659,7 @@ to indicate an unlimited number of listeners. Returns a reference to the `EventEmitter`, so that calls can be chained. -### emitter.rawListeners(eventName) +### `emitter.rawListeners(eventName)` @@ -694,7 +694,7 @@ newListeners[0](); emitter.emit('log'); ``` -## events.once(emitter, name) +## `events.once(emitter, name)`