summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2017-07-14 10:26:45 -0400
committerMyles Borins <mylesborins@google.com>2018-04-16 17:46:03 -0400
commit831de617b0b5f67fb5d88335d91db74968224b5f (patch)
tree47a76ebf5200746911b25d88df694e922394bc74
parentbd032a158aa5be0ecd5e1c1e6b1a535d6977bc83 (diff)
downloadnode-new-831de617b0b5f67fb5d88335d91db74968224b5f.tar.gz
doc: document napi_finalize() signature
Refs: https://github.com/nodejs/node/issues/14138 Backport-PR-URL: https://github.com/nodejs/node/pull/19447 PR-URL: https://github.com/nodejs/node/pull/14230 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
-rw-r--r--doc/api/n-api.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index 8f8aa76f83..0b7294d5bd 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -181,6 +181,12 @@ must provide a function satisfying the following signature which would get
called upon the object's collection. Currently, `napi_finalize` can be used for
finding out when objects that have external data are collected.
+```C
+typedef void (*napi_finalize)(napi_env env,
+ void* finalize_data,
+ void* finalize_hint);
+```
+
#### napi_async_execute_callback
Function pointer used with functions that support asynchronous