Skip to content

Commit

Permalink
doc: async_hooks.createHook promiseResolve option
Browse files Browse the repository at this point in the history
Document the `promiseResolve` option to `async_hooks.createHook()`.

This seems to have been overlooked in commit b605b15 ("async_hooks:
support promise resolve hook") from September 2017.

It is documented elsewhere in the async_hooks API documentation, except
where you actually pass it in.

PR-URL: #29405
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
bnoordhuis authored and targos committed Sep 20, 2019
1 parent b30c40b commit 735ef8b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/api/async_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ added: v8.1.0
* `before` {Function} The [`before` callback][].
* `after` {Function} The [`after` callback][].
* `destroy` {Function} The [`destroy` callback][].
* `promiseResolve` {Function} The [`promiseResolve` callback][].
* Returns: {AsyncHook} Instance used for disabling and enabling hooks

Registers functions to be called for different lifetime events of each async
Expand Down Expand Up @@ -685,6 +686,7 @@ never be called.
[`before` callback]: #async_hooks_before_asyncid
[`destroy` callback]: #async_hooks_destroy_asyncid
[`init` callback]: #async_hooks_init_asyncid_type_triggerasyncid_resource
[`promiseResolve` callback]: #async_hooks_promiseresolve_asyncid
[Hook Callbacks]: #async_hooks_hook_callbacks
[PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit
[`Worker`]: worker_threads.html#worker_threads_class_worker
Expand Down

0 comments on commit 735ef8b

Please sign in to comment.