Skip to content

Commit

Permalink
doc: fix nits in code examples of async_hooks.md
Browse files Browse the repository at this point in the history
* Make `require()` consistent.
* Add missing argument.
* Add missing `\n` in outputs.
* Reduce string concatenations.
* Update outputs.
* Reword and fix a typo.

PR-URL: #13400
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Andreas Madsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
  • Loading branch information
vsemozhetbyt committed Jun 5, 2017
1 parent ce8bce4 commit 5d9dc94
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions doc/api/async_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,13 +220,11 @@ while `triggerId` shows *why* a resource was created.
The following is a simple demonstration of `triggerId`:

```js
const async_hooks = require('async_hooks');

async_hooks.createHook({
init(asyncId, type, triggerId) {
const cId = async_hooks.currentId();
fs.writeSync(1, `${type}(${asyncId}): ` +
`trigger: ${triggerId} scope: ${cId}\n`);
fs.writeSync(
1, `${type}(${asyncId}): trigger: ${triggerId} scope: ${cId}\n`);
}
}).enable();

Expand Down Expand Up @@ -271,25 +269,28 @@ callback to `listen()` will look like. The output formatting is slightly more
elaborate to make calling context easier to see.

```js
const async_hooks = require('async_hooks');

let indent = 0;
async_hooks.createHook({
init(asyncId, type, triggerId) {
const cId = async_hooks.currentId();
fs.writeSync(1, ' '.repeat(indent) + `${type}(${asyncId}): ` +
`trigger: ${triggerId} scope: ${cId}\n`);
const indentStr = ' '.repeat(indent);
fs.writeSync(
1,
`${indentStr}${type}(${asyncId}): trigger: ${triggerId} scope: ${cId}\n`);
},
before(asyncId) {
fs.writeSync(1, ' '.repeat(indent) + `before: ${asyncId}`);
const indentStr = ' '.repeat(indent);
fs.writeSync(1, `${indentStr}before: ${asyncId}\n`);
indent += 2;
},
after(asyncId) {
indent -= 2;
fs.writeSync(1, ' '.repeat(indent) + `after: ${asyncId}`);
const indentStr = ' '.repeat(indent);
fs.writeSync(1, `${indentStr}after: ${asyncId}\n`);
},
destroy(asyncId) {
fs.writeSync(1, ' '.repeat(indent) + `destroy: ${asyncId}`);
const indentStr = ' '.repeat(indent);
fs.writeSync(1, `${indentStr}destroy: ${asyncId}\n`);
},
}).enable();

Expand Down Expand Up @@ -319,10 +320,10 @@ before: 5
>>> 4
TickObject(9): trigger: 4 scope: 4
after: 4
destroy: 4
after: 5
before: 9
after: 9
destroy: 4
destroy: 9
destroy: 5
```
Expand Down Expand Up @@ -395,8 +396,8 @@ For example:

```js
console.log(async_hooks.currentId()); // 1 - bootstrap
fs.open(path, (err, fd) => {
console.log(async_hooks.currentId()); // 2 - open()
fs.open(path, 'r', (err, fd) => {
console.log(async_hooks.currentId()); // 6 - open()
});
```

Expand Down Expand Up @@ -427,9 +428,9 @@ For example:

```js
const server = net.createServer((conn) => {
// Though the resource that caused (or triggered) this callback to
// be called was that of the new connection. Thus the return value
// of triggerId() is the ID of "conn".
// The resource that caused (or triggered) this callback to be called
// was that of the new connection. Thus the return value of triggerId()
// is the asyncId of "conn".
async_hooks.triggerId();

}).listen(port, () => {
Expand Down Expand Up @@ -462,6 +463,8 @@ will occur and node will abort.
The following is an overview of the `AsyncResource` API.

```js
const { AsyncResource } = require('async_hooks');

// AsyncResource() is meant to be extended. Instantiating a
// new AsyncResource() also triggers init. If triggerId is omitted then
// async_hook.currentId() is used.
Expand Down

0 comments on commit 5d9dc94

Please sign in to comment.