From ca8a29c3606421d71ce3120cd34febacd7874293 Mon Sep 17 00:00:00 2001 From: XadillaX Date: Fri, 9 Jun 2017 18:14:22 +0800 Subject: [PATCH] doc: fix out of date napi_callback doc The earlier version `napi_callback` returns `void` but now is `napi_value`. The document of this section hasn't been modified. PR-URL: https://github.com/nodejs/node/pull/13570 Fixes: https://github.com/nodejs/node/issues/12248 Fixes: https://github.com/nodejs/node/issues/13562 Reviewed-By: Gibson Fahnestock Reviewed-By: Colin Ihrig Reviewed-By: Jason Ginchereau Reviewed-By: James M Snell --- doc/api/n-api.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index bc7f605c13bf80..379af3b53c8b1e 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -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); ``` #### *napi_finalize* @@ -2516,8 +2514,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) {