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

doc: fix out of date napi_callback doc #13570

Closed
wants to merge 2 commits into from
Closed

doc: fix out of date napi_callback doc #13570

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
286979e
doc: fix out of date napi_callback doc
XadillaX Jun 9, 2017
3ffd672
change the doc of napi_callback_info
XadillaX Jun 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,18 +161,16 @@ For more details, review the [Object Lifetime Management][].

### N-API Callback types
#### *napi_callback_info*
Opaque datatype that is passed to a callback function. It can be used for two
purposes:
- Get additional information about the context in which the callback was
invoked.
- Set the return value of the callback.
Opaque datatype that is passed to a callback function. It can be used for
getting additional information about the context in which the callback was
invoked.

#### *napi_callback*
Function pointer type for user-provided native functions which are to be
exposed to JavaScript via N-API. Callback functions should satisfy the
following signature:
```C
typedef void (*napi_callback)(napi_env, napi_callback_info);
typedef napi_value (*napi_callback)(napi_env, napi_callback_info);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also update the section above about napi_callback_info: it is no longer used to set the return value.

Copy link
Contributor Author

@XadillaX XadillaX Jun 10, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. 👌 @jasongin

```

#### *napi_finalize*
Expand Down Expand Up @@ -2521,8 +2519,9 @@ In order to expose a function as part of the
add-on's module exports, set the newly created function on the exports
object. A sample module might look as follows:
```C
void SayHello(napi_env env, napi_callback_info info) {
napi_value SayHello(napi_env env, napi_callback_info info) {
printf("Hello\n");
return nullptr;
}

void Init(napi_env env, napi_value exports, napi_value module, void* priv) {
Expand Down