Skip to content

docs: documenting async hooks features #13287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AndreasMadsen wants to merge 18 commits into from
Closed

docs: documenting async hooks features #13287

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
59088f3
docs: async-hooks documentation
thlorenz Nov 28, 2016
1e35d73
[squash] addressing nits pointed out by Trevor
thlorenz Feb 7, 2017
c5db0a6
[squash] renaming Number to number
thlorenz May 10, 2017
3218d31
[squash] addressing simple nits
thlorenz May 18, 2017
aa830d7
[squash] remove standalone JS Embedder API docs
AndreasMadsen May 26, 2017
d09735f
[squash] AsyncEvent is renamed to AsyncResource
AndreasMadsen May 26, 2017
fa37457
[squash] use fs.writeSync and describe issue and solution
AndreasMadsen May 29, 2017
9b9cc15
[squash] async-hooks -> async_hooks
AndreasMadsen May 29, 2017
affa7a7
[squash] addaleax sugestions
AndreasMadsen May 29, 2017
1f23ab2
[squash] jasnell sugestions
AndreasMadsen May 29, 2017
47a51c1
[squash] id => ID
AndreasMadsen May 29, 2017
9864609
[squash] sam-github suggesions
AndreasMadsen May 29, 2017
de40c74
[squash] document resource object and its limitations
AndreasMadsen May 29, 2017
7c9ecd4
[squash] more sam-github suggesions
AndreasMadsen May 29, 2017
de82ef4
[squash] fix typos + make linter pass
addaleax May 29, 2017
d3ee97e
[squash] fix internal link
AndreasMadsen May 29, 2017
4ba706f
[squash] mikesherov suggesion
AndreasMadsen May 30, 2017
82149a8
[squash] trevnorris suggestions
AndreasMadsen Jun 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[squash] document resource object and its limitations
  • Loading branch information
@AndreasMadsen
AndreasMadsen committed May 29, 2017
commit de40c745f9f2242a0d4dfc7260079891f71fcfe7
13 changes: 12 additions & 1 deletion doc/api/async_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,18 @@ hooks.
`triggerId` is the `id` of the resource that caused (or "triggered") the
new resource to initialize and that caused `init()` to call.
Copy link
Copy Markdown
Contributor

@trevnorris trevnorris May 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either move this down to:

The following is a simple demonstration of triggerId:

Or make a note here that there's further explanation below.


The following is a simple demonstration of this:
`resource` is an object that represents the actual resource. This can contain
useful information such as the hostname for the `GETADDRINFOREQWRAP` resource
type, which will be used when looking up the ip for the hostname in
`net.Server.listen`. The API for getting this information is currently not
considered public, but using the Embedder API users can provide and document
their own resource objects. Such as resource object could for example contain
the SQL query being executed.

*Note:* In some cases the resource object is reused for performance reasons,
it is thus not safe to use it as a key in a `WeakMap` or add properties to it.

The following is a simple demonstration of `triggerId`:

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