Skip to content
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

Jump to bottom

N-API Callback Return #13562

Closed
1995parham opened this issue Jun 8, 2017 · 3 comments
Closed

N-API Callback Return #13562

1995parham opened this issue Jun 8, 2017 · 3 comments
Assignees
@mhdawson
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Comments

@1995parham
Copy link

1995parham commented Jun 8, 2017 •
edited
Loading

  • Version: v8.1.0
  • Platform: Linux 4.10.0-21-generic
  • Subsystem:

I think N-API doesn't have any documented way for return something from callbacks. we have just napi_get_cb_info for reading information from napi_callback_info and there is no specific way for write something into them but in documentation mention that it can be used for Set the return value of the callback
@1995parham 1995parham changed the title N-API Function Return N-API Callback Return Jun 8, 2017
@jasongin
Copy link
Member

jasongin commented Jun 8, 2017

The documentation is out of date. You can return a napi_value directly from a function callback. The current definition of napi_callback has a napi_value return type, not void:

typedef napi_value (*napi_callback)(napi_env env, napi_callback_info info);

@jasongin jasongin added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jun 8, 2017
@1995parham
Copy link
Author

Thank you very much @jasongin

@XadillaX XadillaX mentioned this issue Jun 9, 2017
Closed
3 tasks
@mhdawson
Copy link
Member

mhdawson commented Jun 9, 2017

I'll clarify this in a doc PR next week.

@mhdawson mhdawson mentioned this issue Jun 13, 2017
Closed
3 tasks
mhdawson added a commit to mhdawson/io.js that referenced this issue Jun 15, 2017
@mhdawson
doc: fix a few n-api doc issues
05bc598 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

Fixes: nodejs#13555
Fixes: nodejs#13556
Fixes: nodejs#13562
mhdawson added a commit that referenced this issue Jun 16, 2017
@mhdawson
doc: fix a few n-api doc issues
62e940d 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: Ingvar Stepanyan <[email protected]>
addaleax pushed a commit that referenced this issue Jun 17, 2017
@XadillaX @addaleax
doc: fix out of date napi_callback doc
ba68549 
The earlier version `napi_callback` returns `void` but now is
`napi_value`. The document of this section hasn't been modified.

PR-URL: #13570
Fixes: #12248
Fixes: #13562
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
addaleax pushed a commit that referenced this issue Jun 17, 2017
@mhdawson @addaleax
doc: fix a few n-api doc issues
e7b0ec3 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: Ingvar Stepanyan <[email protected]>
addaleax pushed a commit that referenced this issue Jun 21, 2017
@XadillaX @addaleax
doc: fix out of date napi_callback doc
cc92231 
The earlier version `napi_callback` returns `void` but now is
`napi_value`. The document of this section hasn't been modified.

PR-URL: #13570
Fixes: #12248
Fixes: #13562
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
addaleax pushed a commit that referenced this issue Jun 21, 2017
@mhdawson @addaleax
doc: fix a few n-api doc issues
c27ffad 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: Ingvar Stepanyan <[email protected]>
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this issue Apr 10, 2018
@XadillaX
doc: fix out of date napi_callback doc
2b94a31 
The earlier version `napi_callback` returns `void` but now is
`napi_value`. The document of this section hasn't been modified.

PR-URL: nodejs#13570
Fixes: nodejs#12248
Fixes: nodejs#13562
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this issue Apr 10, 2018
@mhdawson
doc: fix a few n-api doc issues
00ee027 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: nodejs#13650
Fixes: nodejs#13555
Fixes: nodejs#13556
Fixes: nodejs#13562
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: Ingvar Stepanyan <[email protected]>
MylesBorins pushed a commit that referenced this issue Apr 16, 2018
@XadillaX @MylesBorins
doc: fix out of date napi_callback doc
1e91d58 
The earlier version `napi_callback` returns `void` but now is
`napi_value`. The document of this section hasn't been modified.

Backport-PR-URL: #19447
PR-URL: #13570
Fixes: #12248
Fixes: #13562
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this issue Apr 16, 2018
@mhdawson @MylesBorins
doc: fix a few n-api doc issues
cc3a4af 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

Backport-PR-URL: #19447
PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jason Ginchereau <[email protected]>
Reviewed-By: Ingvar Stepanyan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mhdawson mhdawson

Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: fix out of date napi_callback doc XadillaX/node
3 participants
@1995parham @mhdawson @jasongin