diff options
author | Rich Trott <rtrott@gmail.com> | 2019-12-24 04:28:33 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-12-27 08:39:24 +0300 |
commit | 75ab328b681ef0194361fe2ef7b3d8a8c7c1b5ef (patch) | |
tree | 8c31784e546f01f7f4c6d8e26c8f1b9d105213b5 /doc/api/domain.md | |
parent | 0c8ff7c78c91a1002757715d0d4a8f84a59faff9 (diff) |
doc,domain: use code markup/markdown in headers
PR-URL: https://github.com/nodejs/node/pull/31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/domain.md')
-rw-r--r-- | doc/api/domain.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/api/domain.md b/doc/api/domain.md index d0ba5a446d9..fa3aef66b98 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -184,7 +184,7 @@ function handleRequest(req, res) { } ``` -## Additions to Error objects +## Additions to `Error` objects <!-- type=misc --> @@ -267,11 +267,11 @@ serverDomain.run(() => { }); ``` -## domain.create() +## `domain.create()` * Returns: {Domain} -## Class: Domain +## Class: `Domain` * Extends: {EventEmitter} @@ -280,14 +280,14 @@ uncaught exceptions to the active `Domain` object. To handle the errors that it catches, listen to its `'error'` event. -### domain.members +### `domain.members` * {Array} An array of timers and event emitters that have been explicitly added to the domain. -### domain.add(emitter) +### `domain.add(emitter)` * `emitter` {EventEmitter|Timer} emitter or timer to be added to the domain @@ -303,7 +303,7 @@ the domain `'error'` handler. If the Timer or `EventEmitter` was already bound to a domain, it is removed from that one, and bound to this one instead. -### domain.bind(callback) +### `domain.bind(callback)` * `callback` {Function} The callback function * Returns: {Function} The bound function @@ -328,7 +328,7 @@ d.on('error', (er) => { }); ``` -### domain.enter() +### `domain.enter()` The `enter()` method is plumbing used by the `run()`, `bind()`, and `intercept()` methods to set the active domain. It sets `domain.active` and @@ -341,7 +341,7 @@ Calling `enter()` changes only the active domain, and does not alter the domain itself. `enter()` and `exit()` can be called an arbitrary number of times on a single domain. -### domain.exit() +### `domain.exit()` The `exit()` method exits the current domain, popping it off the domain stack. Any time execution is going to switch to the context of a different chain of @@ -356,7 +356,7 @@ Calling `exit()` changes only the active domain, and does not alter the domain itself. `enter()` and `exit()` can be called an arbitrary number of times on a single domain. -### domain.intercept(callback) +### `domain.intercept(callback)` * `callback` {Function} The callback function * Returns: {Function} The intercepted function @@ -391,14 +391,14 @@ d.on('error', (er) => { }); ``` -### domain.remove(emitter) +### `domain.remove(emitter)` * `emitter` {EventEmitter|Timer} emitter or timer to be removed from the domain The opposite of [`domain.add(emitter)`][]. Removes domain handling from the specified emitter. -### domain.run(fn\[, ...args\]) +### `domain.run(fn[, ...args])` * `fn` {Function} * `...args` {any} |