0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc
Michael Dawson 3662b0c2c7 doc: update napi_async_init documentation
Fixes: https://github.com/nodejs/node/issues/33153

Change documentation to make async_resource required
as opposed to optional in napi-async_init.

Changes over time mean this parameter is required for
proper operation of async hooks (which are still experimental).
This changes the documentation to document what
callers should do. We are doing this only in the doc
in order to avoid a breaking change in N-API. We could
create a new version of the method for which the
parametrer is enforced as mandatory but we should only
do that once async hooks is no longer experimental. In
that case we could deprecate (but not remove this version
of the method).

Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

PR-URL: https://github.com/nodejs/node/pull/33181
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
2020-05-06 14:58:14 -04:00
..
api doc: update napi_async_init documentation 2020-05-06 14:58:14 -04:00
api_assets doc: prevent tables from shrinking page 2020-03-11 16:59:16 +01:00
changelogs 2020-05-05, Version 14.2.0 (Current) 2020-05-05 20:24:37 +02:00
guides doc: clarify when not to run CI on docs 2020-05-02 10:24:36 +05:30
.eslintrc.yaml
abi_version_registry.json doc: set module version 83 to node 14 2020-04-22 10:37:19 +02:00
first_timer_badge.png
full-white-stripe.jpg
node.1 module: partial doc removal of --experimental-modules 2020-04-21 16:13:11 -04:00
osx_installer_logo.png
template.html doc: specify display=fallback for Google Fonts 2019-09-26 22:46:34 -07:00
thin-white-stripe.jpg