doc: update napi_async_init documentation - #33181
Closed
mhdawson wants to merge 4 commits into
Closed
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Fixes: nodejs#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>
mhdawson
marked this pull request as draft
April 30, 2020 23:00
legendecas
reviewed
May 1, 2020
Comment thread
doc/api/n-api.md
Outdated
Flarna
approved these changes
May 4, 2020
Co-authored-by: legendecas <legendecas@gmail.com>
mhdawson
commented
May 4, 2020
Comment thread
doc/api/n-api.md
mhdawson
commented
May 4, 2020
Comment thread
doc/api/n-api.md
Outdated
mhdawson
marked this pull request as ready for review
May 4, 2020 15:51
Copy link
Copy Markdown
Member
Author
|
@legendecas addressed your comment. |
Sorry, something went wrong.
legendecas
approved these changes
May 5, 2020
legendecas
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
|
Doc only and liters were ok so landing. |
Sorry, something went wrong.
mhdawson
added a commit
that referenced
this pull request
May 6, 2020
Fixes: #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: #33181 Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
codebytere
pushed a commit
that referenced
this pull request
May 7, 2020
Fixes: #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: #33181 Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Merged
codebytere
pushed a commit
that referenced
this pull request
Jun 7, 2020
Fixes: #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: #33181 Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Merged
This was referenced Jan 31, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #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
Checklist