★ wanayoo — archive 1999 https://github.com/nodejs/node/pull/25366Nouvelle recherche | Portail wanayoo
Skip to content

/node

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.

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

doc: NAPI `napi_open_callback_scope` #25366

Closed
wants to merge 1 commit into from
+1 −1

Conversation

@DaAitch
Copy link
Contributor

commented Jan 6, 2019

  • parameter resource_object is mandatory
Checklist

Description

According to documention napi_open_callback_scope's parameter resource_object is optional.

[in] resource_object: An optional object associated with the async work that will be passed to possible async_hooks init hooks.

, but when I do this:

status = napi_open_callback_scope(env, nullptr, async_context, &scope);

I get napi_invalid_arg and when I do this:

status = napi_open_callback_scope(env, resource_object, async_context, &scope);

it's napi_ok, so I checked impl and found this in node_api.cc:

v8::Local<v8::Object> resource;
CHECK_TO_OBJECT(env, context, resource, resource_object);

which makes me think that documentation is wrong, so here the PR for documentation.

@nodejs-github-bot nodejs-github-bot added doc n-api labels Jan 6, 2019

@DaAitch
doc: napi `napi_open_callback_scope` 
- parameter `resource_object` is mandatory
Loading status checks…
94a5373

@DaAitch DaAitch force-pushed the DaAitch:fix/doc_napi_open_callback_scope branch from b83d610 to 94a5373 Jan 6, 2019

@mhdawson
mhdawson approved these changes Jan 7, 2019
View changes
Copy link
Member

left a comment

LGTM since it documents current behavior.
@vsemozhetbyt

This comment has been minimized.

Sign in to view
Copy link
Contributor

commented Jan 13, 2019

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/2241/
@vsemozhetbyt

This comment has been minimized.

Sign in to view
Copy link
Contributor

commented Jan 13, 2019

Landed in 9e7d4ca
Thank you!

@vsemozhetbyt vsemozhetbyt closed this Jan 13, 2019

vsemozhetbyt added a commit that referenced this pull request Jan 13, 2019
@DaAitch @vsemozhetbyt
doc: fix `napi_open_callback_scope` description 
- parameter `resource_object` is mandatory

PR-URL: #25366
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Loading status checks…
9e7d4ca
addaleax added a commit that referenced this pull request Jan 14, 2019
@DaAitch @addaleax
doc: fix `napi_open_callback_scope` description 
- parameter `resource_object` is mandatory

PR-URL: #25366
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Verified
This commit was signed with a verified signature.
addaleax Anna Henningsen
GPG key ID: 9C63F3A6CD2AD8F9 Learn about signing commits
f8bb544
@BridgeAR BridgeAR referenced this pull request Jan 16, 2019
Merged
BridgeAR added a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
@DaAitch @BridgeAR
doc: fix `napi_open_callback_scope` description 
- parameter `resource_object` is mandatory

PR-URL: nodejs#25366
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Verified
This commit was signed with a verified signature.
BridgeAR Ruben Bridgewater
GPG key ID: F07496B3EB3C1762 Learn about signing commits
75e1903
@MylesBorins MylesBorins referenced this pull request Jan 24, 2019
Merged
BethGriggs added a commit that referenced this pull request Apr 28, 2019
@DaAitch @BethGriggs
doc: fix `napi_open_callback_scope` description 
- parameter `resource_object` is mandatory

PR-URL: #25366
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Verified
This commit was signed with a verified signature.
BethGriggs Bethany Nicolle Griggs
GPG key ID: D7062848A1AB005C Learn about signing commits
e8271a4
@BethGriggs BethGriggs referenced this pull request May 1, 2019
Merged
BethGriggs added a commit that referenced this pull request May 10, 2019
@DaAitch @BethGriggs
doc: fix `napi_open_callback_scope` description 
- parameter `resource_object` is mandatory

PR-URL: #25366
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Verified
This commit was signed with a verified signature.
BethGriggs Bethany Nicolle Griggs
GPG key ID: D7062848A1AB005C Learn about signing commits
78e2652
MylesBorins added a commit that referenced this pull request May 16, 2019
@DaAitch @MylesBorins
doc: fix `napi_open_callback_scope` description 
- parameter `resource_object` is mandatory

PR-URL: #25366
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Verified
This commit was signed with a verified signature.
MylesBorins Myles Borins
GPG key ID: 933B01F40B5CA946 Learn about signing commits
9dffc2b
This was referenced May 29, 2019
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhdawson mhdawson

Assignees
No one assigned
Labels
doc n-api
Projects
None yet
Milestone
No milestone
4 participants
@DaAitch @vsemozhetbyt @mhdawson @nodejs-github-bot
You can’t perform that action at this time.