koffi 1.1.0-beta.1 → 1.1.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (270) hide show
  1. package/CMakeLists.txt +4 -0
  2. package/README.md +20 -11
  3. package/build/qemu/1.1.0-beta.4/koffi_darwin_x64.tar.gz +0 -0
  4. package/build/qemu/1.1.0-beta.4/koffi_freebsd_arm64.tar.gz +0 -0
  5. package/build/qemu/1.1.0-beta.4/koffi_freebsd_ia32.tar.gz +0 -0
  6. package/build/qemu/1.1.0-beta.4/koffi_freebsd_x64.tar.gz +0 -0
  7. package/build/qemu/1.1.0-beta.4/koffi_linux_arm.tar.gz +0 -0
  8. package/build/qemu/1.1.0-beta.4/koffi_linux_arm64.tar.gz +0 -0
  9. package/build/qemu/1.1.0-beta.4/koffi_linux_ia32.tar.gz +0 -0
  10. package/build/qemu/1.1.0-beta.4/koffi_linux_x64.tar.gz +0 -0
  11. package/build/qemu/1.1.0-beta.4/koffi_win32_ia32.tar.gz +0 -0
  12. package/build/qemu/1.1.0-beta.4/koffi_win32_x64.tar.gz +0 -0
  13. package/package.json +1 -1
  14. package/qemu/qemu.js +1 -0
  15. package/src/abi_arm32.cc +27 -45
  16. package/src/abi_arm64.cc +58 -132
  17. package/src/abi_x64_sysv.cc +24 -7
  18. package/src/abi_x64_win.cc +3 -0
  19. package/src/abi_x86.cc +3 -0
  20. package/src/call.cc +540 -33
  21. package/src/call.hh +5 -3
  22. package/src/ffi.cc +129 -4
  23. package/src/ffi.hh +5 -1
  24. package/src/parser.cc +7 -2
  25. package/src/util.cc +72 -0
  26. package/src/util.hh +2 -0
  27. package/test/misc.c +14 -8
  28. package/vendor/node-addon-api/CODE_OF_CONDUCT.md +4 -0
  29. package/vendor/node-addon-api/CONTRIBUTING.md +93 -0
  30. package/vendor/node-addon-api/appveyor.yml +37 -0
  31. package/vendor/node-addon-api/benchmark/README.md +47 -0
  32. package/vendor/node-addon-api/benchmark/binding.gyp +25 -0
  33. package/vendor/node-addon-api/benchmark/function_args.cc +217 -0
  34. package/vendor/node-addon-api/benchmark/function_args.js +60 -0
  35. package/vendor/node-addon-api/benchmark/index.js +34 -0
  36. package/vendor/node-addon-api/benchmark/property_descriptor.cc +91 -0
  37. package/vendor/node-addon-api/benchmark/property_descriptor.js +37 -0
  38. package/vendor/node-addon-api/doc/addon.md +163 -0
  39. package/vendor/node-addon-api/doc/array.md +81 -0
  40. package/vendor/node-addon-api/doc/array_buffer.md +155 -0
  41. package/vendor/node-addon-api/doc/async_context.md +86 -0
  42. package/vendor/node-addon-api/doc/async_operations.md +31 -0
  43. package/vendor/node-addon-api/doc/async_worker.md +427 -0
  44. package/vendor/node-addon-api/doc/async_worker_variants.md +557 -0
  45. package/vendor/node-addon-api/doc/bigint.md +97 -0
  46. package/vendor/node-addon-api/doc/boolean.md +68 -0
  47. package/vendor/node-addon-api/doc/buffer.md +150 -0
  48. package/vendor/node-addon-api/doc/callback_scope.md +54 -0
  49. package/vendor/node-addon-api/doc/callbackinfo.md +97 -0
  50. package/vendor/node-addon-api/doc/checker-tool.md +32 -0
  51. package/vendor/node-addon-api/doc/class_property_descriptor.md +123 -0
  52. package/vendor/node-addon-api/doc/cmake-js.md +68 -0
  53. package/vendor/node-addon-api/doc/conversion-tool.md +28 -0
  54. package/vendor/node-addon-api/doc/creating_a_release.md +62 -0
  55. package/vendor/node-addon-api/doc/dataview.md +248 -0
  56. package/vendor/node-addon-api/doc/date.md +68 -0
  57. package/vendor/node-addon-api/doc/env.md +196 -0
  58. package/vendor/node-addon-api/doc/error.md +120 -0
  59. package/vendor/node-addon-api/doc/error_handling.md +254 -0
  60. package/vendor/node-addon-api/doc/escapable_handle_scope.md +80 -0
  61. package/vendor/node-addon-api/doc/external.md +63 -0
  62. package/vendor/node-addon-api/doc/function.md +402 -0
  63. package/vendor/node-addon-api/doc/function_reference.md +238 -0
  64. package/vendor/node-addon-api/doc/generator.md +13 -0
  65. package/vendor/node-addon-api/doc/handle_scope.md +63 -0
  66. package/vendor/node-addon-api/doc/hierarchy.md +91 -0
  67. package/vendor/node-addon-api/doc/instance_wrap.md +408 -0
  68. package/vendor/node-addon-api/doc/maybe.md +76 -0
  69. package/vendor/node-addon-api/doc/memory_management.md +27 -0
  70. package/vendor/node-addon-api/doc/name.md +29 -0
  71. package/vendor/node-addon-api/doc/node-gyp.md +82 -0
  72. package/vendor/node-addon-api/doc/number.md +163 -0
  73. package/vendor/node-addon-api/doc/object.md +411 -0
  74. package/vendor/node-addon-api/doc/object_lifetime_management.md +83 -0
  75. package/vendor/node-addon-api/doc/object_reference.md +117 -0
  76. package/vendor/node-addon-api/doc/object_wrap.md +588 -0
  77. package/vendor/node-addon-api/doc/prebuild_tools.md +16 -0
  78. package/vendor/node-addon-api/doc/promises.md +79 -0
  79. package/vendor/node-addon-api/doc/property_descriptor.md +286 -0
  80. package/vendor/node-addon-api/doc/propertylvalue.md +50 -0
  81. package/vendor/node-addon-api/doc/range_error.md +59 -0
  82. package/vendor/node-addon-api/doc/reference.md +113 -0
  83. package/vendor/node-addon-api/doc/setup.md +110 -0
  84. package/vendor/node-addon-api/doc/string.md +93 -0
  85. package/vendor/node-addon-api/doc/symbol.md +61 -0
  86. package/vendor/node-addon-api/doc/threadsafe.md +121 -0
  87. package/vendor/node-addon-api/doc/threadsafe_function.md +290 -0
  88. package/vendor/node-addon-api/doc/type_error.md +59 -0
  89. package/vendor/node-addon-api/doc/typed_array.md +78 -0
  90. package/vendor/node-addon-api/doc/typed_array_of.md +137 -0
  91. package/vendor/node-addon-api/doc/typed_threadsafe_function.md +306 -0
  92. package/vendor/node-addon-api/doc/value.md +340 -0
  93. package/vendor/node-addon-api/doc/version_management.md +43 -0
  94. package/vendor/node-addon-api/package.json +415 -0
  95. package/vendor/node-addon-api/test/README.md +91 -0
  96. package/vendor/node-addon-api/test/addon.cc +36 -0
  97. package/vendor/node-addon-api/test/addon.js +11 -0
  98. package/vendor/node-addon-api/test/addon_build/index.js +49 -0
  99. package/vendor/node-addon-api/test/addon_build/tpl/addon.cc +17 -0
  100. package/vendor/node-addon-api/test/addon_build/tpl/binding.gyp +62 -0
  101. package/vendor/node-addon-api/test/addon_build/tpl/index.js +9 -0
  102. package/vendor/node-addon-api/test/addon_build/tpl/package.json +11 -0
  103. package/vendor/node-addon-api/test/addon_data.cc +99 -0
  104. package/vendor/node-addon-api/test/addon_data.js +46 -0
  105. package/vendor/node-addon-api/test/array_buffer.cc +243 -0
  106. package/vendor/node-addon-api/test/array_buffer.js +69 -0
  107. package/vendor/node-addon-api/test/async_context.cc +36 -0
  108. package/vendor/node-addon-api/test/async_context.js +122 -0
  109. package/vendor/node-addon-api/test/async_progress_queue_worker.cc +83 -0
  110. package/vendor/node-addon-api/test/async_progress_queue_worker.js +46 -0
  111. package/vendor/node-addon-api/test/async_progress_worker.cc +134 -0
  112. package/vendor/node-addon-api/test/async_progress_worker.js +61 -0
  113. package/vendor/node-addon-api/test/async_worker.cc +106 -0
  114. package/vendor/node-addon-api/test/async_worker.js +179 -0
  115. package/vendor/node-addon-api/test/async_worker_nocallback.js +13 -0
  116. package/vendor/node-addon-api/test/async_worker_persistent.cc +63 -0
  117. package/vendor/node-addon-api/test/async_worker_persistent.js +24 -0
  118. package/vendor/node-addon-api/test/basic_types/array.cc +40 -0
  119. package/vendor/node-addon-api/test/basic_types/array.js +35 -0
  120. package/vendor/node-addon-api/test/basic_types/boolean.cc +38 -0
  121. package/vendor/node-addon-api/test/basic_types/boolean.js +35 -0
  122. package/vendor/node-addon-api/test/basic_types/number.cc +99 -0
  123. package/vendor/node-addon-api/test/basic_types/number.js +114 -0
  124. package/vendor/node-addon-api/test/basic_types/value.cc +120 -0
  125. package/vendor/node-addon-api/test/basic_types/value.js +133 -0
  126. package/vendor/node-addon-api/test/bigint.cc +91 -0
  127. package/vendor/node-addon-api/test/bigint.js +53 -0
  128. package/vendor/node-addon-api/test/binding-swallowexcept.cc +12 -0
  129. package/vendor/node-addon-api/test/binding.cc +173 -0
  130. package/vendor/node-addon-api/test/binding.gyp +124 -0
  131. package/vendor/node-addon-api/test/buffer.cc +183 -0
  132. package/vendor/node-addon-api/test/buffer.js +69 -0
  133. package/vendor/node-addon-api/test/callbackscope.cc +22 -0
  134. package/vendor/node-addon-api/test/callbackscope.js +49 -0
  135. package/vendor/node-addon-api/test/common/index.js +114 -0
  136. package/vendor/node-addon-api/test/common/test_helper.h +71 -0
  137. package/vendor/node-addon-api/test/dataview/dataview.cc +48 -0
  138. package/vendor/node-addon-api/test/dataview/dataview.js +35 -0
  139. package/vendor/node-addon-api/test/dataview/dataview_read_write.cc +115 -0
  140. package/vendor/node-addon-api/test/dataview/dataview_read_write.js +90 -0
  141. package/vendor/node-addon-api/test/date.cc +44 -0
  142. package/vendor/node-addon-api/test/date.js +18 -0
  143. package/vendor/node-addon-api/test/env_cleanup.cc +88 -0
  144. package/vendor/node-addon-api/test/env_cleanup.js +56 -0
  145. package/vendor/node-addon-api/test/error.cc +287 -0
  146. package/vendor/node-addon-api/test/error.js +81 -0
  147. package/vendor/node-addon-api/test/error_handling_for_primitives.cc +13 -0
  148. package/vendor/node-addon-api/test/error_handling_for_primitives.js +29 -0
  149. package/vendor/node-addon-api/test/error_terminating_environment.js +95 -0
  150. package/vendor/node-addon-api/test/external.cc +81 -0
  151. package/vendor/node-addon-api/test/external.js +88 -0
  152. package/vendor/node-addon-api/test/function.cc +324 -0
  153. package/vendor/node-addon-api/test/function.js +133 -0
  154. package/vendor/node-addon-api/test/function_reference.cc +202 -0
  155. package/vendor/node-addon-api/test/function_reference.js +157 -0
  156. package/vendor/node-addon-api/test/globalObject/global_object.cc +61 -0
  157. package/vendor/node-addon-api/test/globalObject/global_object_delete_property.cc +31 -0
  158. package/vendor/node-addon-api/test/globalObject/global_object_delete_property.js +61 -0
  159. package/vendor/node-addon-api/test/globalObject/global_object_get_property.cc +40 -0
  160. package/vendor/node-addon-api/test/globalObject/global_object_get_property.js +57 -0
  161. package/vendor/node-addon-api/test/globalObject/global_object_has_own_property.cc +28 -0
  162. package/vendor/node-addon-api/test/globalObject/global_object_has_own_property.js +48 -0
  163. package/vendor/node-addon-api/test/globalObject/global_object_set_property.cc +31 -0
  164. package/vendor/node-addon-api/test/globalObject/global_object_set_property.js +58 -0
  165. package/vendor/node-addon-api/test/handlescope.cc +60 -0
  166. package/vendor/node-addon-api/test/handlescope.js +14 -0
  167. package/vendor/node-addon-api/test/index.js +159 -0
  168. package/vendor/node-addon-api/test/maybe/check.cc +23 -0
  169. package/vendor/node-addon-api/test/maybe/index.js +38 -0
  170. package/vendor/node-addon-api/test/memory_management.cc +17 -0
  171. package/vendor/node-addon-api/test/memory_management.js +9 -0
  172. package/vendor/node-addon-api/test/movable_callbacks.cc +23 -0
  173. package/vendor/node-addon-api/test/movable_callbacks.js +21 -0
  174. package/vendor/node-addon-api/test/name.cc +108 -0
  175. package/vendor/node-addon-api/test/name.js +59 -0
  176. package/vendor/node-addon-api/test/napi_child.js +14 -0
  177. package/vendor/node-addon-api/test/object/delete_property.cc +38 -0
  178. package/vendor/node-addon-api/test/object/delete_property.js +41 -0
  179. package/vendor/node-addon-api/test/object/finalizer.cc +29 -0
  180. package/vendor/node-addon-api/test/object/finalizer.js +28 -0
  181. package/vendor/node-addon-api/test/object/get_property.cc +34 -0
  182. package/vendor/node-addon-api/test/object/get_property.js +40 -0
  183. package/vendor/node-addon-api/test/object/has_own_property.cc +34 -0
  184. package/vendor/node-addon-api/test/object/has_own_property.js +34 -0
  185. package/vendor/node-addon-api/test/object/has_property.cc +38 -0
  186. package/vendor/node-addon-api/test/object/has_property.js +37 -0
  187. package/vendor/node-addon-api/test/object/object.cc +350 -0
  188. package/vendor/node-addon-api/test/object/object.js +217 -0
  189. package/vendor/node-addon-api/test/object/object_deprecated.cc +66 -0
  190. package/vendor/node-addon-api/test/object/object_deprecated.js +47 -0
  191. package/vendor/node-addon-api/test/object/object_freeze_seal.cc +25 -0
  192. package/vendor/node-addon-api/test/object/object_freeze_seal.js +61 -0
  193. package/vendor/node-addon-api/test/object/set_property.cc +45 -0
  194. package/vendor/node-addon-api/test/object/set_property.js +30 -0
  195. package/vendor/node-addon-api/test/object/subscript_operator.cc +58 -0
  196. package/vendor/node-addon-api/test/object/subscript_operator.js +17 -0
  197. package/vendor/node-addon-api/test/object_reference.cc +219 -0
  198. package/vendor/node-addon-api/test/object_reference.js +259 -0
  199. package/vendor/node-addon-api/test/objectwrap.cc +268 -0
  200. package/vendor/node-addon-api/test/objectwrap.js +284 -0
  201. package/vendor/node-addon-api/test/objectwrap_constructor_exception.cc +26 -0
  202. package/vendor/node-addon-api/test/objectwrap_constructor_exception.js +18 -0
  203. package/vendor/node-addon-api/test/objectwrap_function.cc +45 -0
  204. package/vendor/node-addon-api/test/objectwrap_function.js +22 -0
  205. package/vendor/node-addon-api/test/objectwrap_multiple_inheritance.cc +30 -0
  206. package/vendor/node-addon-api/test/objectwrap_multiple_inheritance.js +13 -0
  207. package/vendor/node-addon-api/test/objectwrap_removewrap.cc +45 -0
  208. package/vendor/node-addon-api/test/objectwrap_removewrap.js +40 -0
  209. package/vendor/node-addon-api/test/objectwrap_worker_thread.js +19 -0
  210. package/vendor/node-addon-api/test/promise.cc +29 -0
  211. package/vendor/node-addon-api/test/promise.js +18 -0
  212. package/vendor/node-addon-api/test/reference.cc +24 -0
  213. package/vendor/node-addon-api/test/reference.js +14 -0
  214. package/vendor/node-addon-api/test/run_script.cc +56 -0
  215. package/vendor/node-addon-api/test/run_script.js +45 -0
  216. package/vendor/node-addon-api/test/symbol.cc +79 -0
  217. package/vendor/node-addon-api/test/symbol.js +73 -0
  218. package/vendor/node-addon-api/test/testUtil.js +54 -0
  219. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function.cc +195 -0
  220. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function.js +188 -0
  221. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ctx.cc +63 -0
  222. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ctx.js +12 -0
  223. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_existing_tsfn.cc +115 -0
  224. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_existing_tsfn.js +14 -0
  225. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ptr.cc +26 -0
  226. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ptr.js +7 -0
  227. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_sum.cc +225 -0
  228. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_sum.js +59 -0
  229. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_unref.cc +42 -0
  230. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_unref.js +53 -0
  231. package/vendor/node-addon-api/test/thunking_manual.cc +140 -0
  232. package/vendor/node-addon-api/test/thunking_manual.js +17 -0
  233. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function.cc +215 -0
  234. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function.js +188 -0
  235. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ctx.cc +68 -0
  236. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ctx.js +12 -0
  237. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_existing_tsfn.cc +127 -0
  238. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_existing_tsfn.js +14 -0
  239. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ptr.cc +28 -0
  240. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ptr.js +7 -0
  241. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_sum.cc +237 -0
  242. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_sum.js +59 -0
  243. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_unref.cc +53 -0
  244. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_unref.js +53 -0
  245. package/vendor/node-addon-api/test/typedarray-bigint.js +58 -0
  246. package/vendor/node-addon-api/test/typedarray.cc +216 -0
  247. package/vendor/node-addon-api/test/typedarray.js +69 -0
  248. package/vendor/node-addon-api/test/version_management.cc +27 -0
  249. package/vendor/node-addon-api/test/version_management.js +31 -0
  250. package/vendor/node-addon-api/unit-test/README.md +28 -0
  251. package/vendor/node-addon-api/unit-test/binding-file-template.js +39 -0
  252. package/vendor/node-addon-api/unit-test/binding.gyp +72 -0
  253. package/vendor/node-addon-api/unit-test/exceptions.js +32 -0
  254. package/vendor/node-addon-api/unit-test/generate-binding-cc.js +61 -0
  255. package/vendor/node-addon-api/unit-test/injectTestParams.js +101 -0
  256. package/vendor/node-addon-api/unit-test/listOfTestModules.js +88 -0
  257. package/vendor/node-addon-api/unit-test/matchModules.js +65 -0
  258. package/vendor/node-addon-api/unit-test/setup.js +13 -0
  259. package/vendor/node-addon-api/unit-test/spawnTask.js +26 -0
  260. package/vendor/node-addon-api/unit-test/test.js +30 -0
  261. package/build/qemu/1.1.0-beta.1/koffi_darwin_x64.tar.gz +0 -0
  262. package/build/qemu/1.1.0-beta.1/koffi_freebsd_arm64.tar.gz +0 -0
  263. package/build/qemu/1.1.0-beta.1/koffi_freebsd_ia32.tar.gz +0 -0
  264. package/build/qemu/1.1.0-beta.1/koffi_freebsd_x64.tar.gz +0 -0
  265. package/build/qemu/1.1.0-beta.1/koffi_linux_arm.tar.gz +0 -0
  266. package/build/qemu/1.1.0-beta.1/koffi_linux_arm64.tar.gz +0 -0
  267. package/build/qemu/1.1.0-beta.1/koffi_linux_ia32.tar.gz +0 -0
  268. package/build/qemu/1.1.0-beta.1/koffi_linux_x64.tar.gz +0 -0
  269. package/build/qemu/1.1.0-beta.1/koffi_win32_ia32.tar.gz +0 -0
  270. package/build/qemu/1.1.0-beta.1/koffi_win32_x64.tar.gz +0 -0
@@ -0,0 +1,63 @@
1
+ # HandleScope
2
+
3
+ The HandleScope class is used to manage the lifetime of object handles
4
+ which are created through the use of node-addon-api. These handles
5
+ keep an object alive in the heap in order to ensure that the objects
6
+ are not collected while native code is using them.
7
+ A handle may be created when any new node-addon-api Value or one
8
+ of its subclasses is created or returned. For more details refer to
9
+ the section titled [Object lifetime management](object_lifetime_management.md).
10
+
11
+ ## Methods
12
+
13
+ ### Constructor
14
+
15
+ Creates a new handle scope on the stack.
16
+
17
+ ```cpp
18
+ Napi::HandleScope::HandleScope(Napi::Env env);
19
+ ```
20
+
21
+ - `[in] env`: The environment in which to construct the `Napi::HandleScope` object.
22
+
23
+ Returns a new `Napi::HandleScope`
24
+
25
+ ### Constructor
26
+
27
+ Creates a new handle scope on the stack.
28
+
29
+ ```cpp
30
+ Napi::HandleScope::HandleScope(Napi::Env env, Napi::HandleScope scope);
31
+ ```
32
+
33
+ - `[in] env`: `Napi::Env` in which the scope passed in was created.
34
+ - `[in] scope`: pre-existing `Napi::HandleScope`.
35
+
36
+ Returns a new `Napi::HandleScope` instance which wraps the `napi_handle_scope`
37
+ handle passed in. This can be used to mix usage of the C Node-API
38
+ and node-addon-api.
39
+
40
+ ```cpp
41
+ operator Napi::HandleScope::napi_handle_scope() const
42
+ ```
43
+
44
+ Returns the Node-API `napi_handle_scope` wrapped by the `Napi::EscapableHandleScope` object.
45
+ This can be used to mix usage of the C Node-API and node-addon-api by allowing
46
+ the class to be used be converted to a `napi_handle_scope`.
47
+
48
+ ### Destructor
49
+ ```cpp
50
+ Napi::HandleScope::~HandleScope();
51
+ ```
52
+
53
+ Deletes the `Napi::HandleScope` instance and allows any objects/handles created
54
+ in the scope to be collected by the garbage collector. There is no
55
+ guarantee as to when the garbage collector will do this.
56
+
57
+ ### Env
58
+
59
+ ```cpp
60
+ Napi::Env Napi::HandleScope::Env() const;
61
+ ```
62
+
63
+ Returns the `Napi::Env` associated with the `Napi::HandleScope`.
@@ -0,0 +1,91 @@
1
+ # Full Class Hierarchy
2
+
3
+ | Class | Parent Class(es) |
4
+ |---|---|
5
+ | [`Napi::Addon`][] | [`Napi::InstanceWrap`][] |
6
+ | [`Napi::Array`][] | [`Napi::Object`][] |
7
+ | [`Napi::ArrayBuffer`][] | [`Napi::Object`][] |
8
+ | [`Napi::AsyncContext`][] | |
9
+ | [`Napi::AsyncProgressQueueWorker`][] | `Napi::AsyncProgressWorkerBase` |
10
+ | [`Napi::AsyncProgressWorker`][] | `Napi::AsyncProgressWorkerBase` |
11
+ | [`Napi::AsyncWorker`][] | |
12
+ | [`Napi::BigInt`][] | [`Napi::Value`][] |
13
+ | [`Napi::Boolean`][] | [`Napi::Value`][] |
14
+ | [`Napi::Buffer`][] | [`Napi::Uint8Array`][] |
15
+ | [`Napi::CallbackInfo`][] | |
16
+ | [`Napi::CallbackScope`][] | |
17
+ | [`Napi::ClassPropertyDescriptor`][] | |
18
+ | [`Napi::DataView`][] | [`Napi::Object`][] |
19
+ | [`Napi::Date`][] | [`Napi::Value`][] |
20
+ | [`Napi::Env`][] | |
21
+ | [`Napi::Error`][] | [`Napi::ObjectReference`][], [`std::exception`][] |
22
+ | [`Napi::EscapableHandleScope`][] | |
23
+ | [`Napi::External`][] | [`Napi::Value`][] |
24
+ | [`Napi::Function`][] | [`Napi::Object`][] |
25
+ | [`Napi::FunctionReference`][] | [`Napi::Reference<Napi::Function>`][] |
26
+ | [`Napi::HandleScope`][] | |
27
+ | [`Napi::InstanceWrap`][] | |
28
+ | [`Napi::MemoryManagement`][] | |
29
+ | [`Napi::Name`][] | [`Napi::Value`][] |
30
+ | [`Napi::Number`][] | [`Napi::Value`][] |
31
+ | [`Napi::Object`][] | [`Napi::Value`][] |
32
+ | [`Napi::ObjectReference`][] | [`Napi::Reference<Napi::Object>`][] |
33
+ | [`Napi::ObjectWrap`][] | [`Napi::InstanceWrap`][], [`Napi::Reference<Napi::Object>`][] |
34
+ | [`Napi::Promise`][] | [`Napi::Object`][] |
35
+ | [`Napi::PropertyDescriptor`][] | |
36
+ | [`Napi::RangeError`][] | [`Napi::Error`][] |
37
+ | [`Napi::Reference`] | |
38
+ | [`Napi::String`][] | [`Napi::Name`][] |
39
+ | [`Napi::Symbol`][] | [`Napi::Name`][] |
40
+ | [`Napi::ThreadSafeFunction`][] | |
41
+ | [`Napi::TypeError`][] | [`Napi::Error`][] |
42
+ | [`Napi::TypedArray`][] | [`Napi::Object`][] |
43
+ | [`Napi::TypedArrayOf`][] | [`Napi::TypedArray`][] |
44
+ | [`Napi::Value`][] | |
45
+ | [`Napi::VersionManagement`][] | |
46
+
47
+ [`Napi::Addon`]: ./addon.md
48
+ [`Napi::Array`]: ./array.md
49
+ [`Napi::ArrayBuffer`]: ./array_buffer.md
50
+ [`Napi::AsyncContext`]: ./async_context.md
51
+ [`Napi::AsyncProgressQueueWorker`]: ./async_worker_variants.md#asyncprogressqueueworker
52
+ [`Napi::AsyncProgressWorker`]: ./async_worker_variants.md#asyncprogressworker
53
+ [`Napi::AsyncWorker`]: ./async_worker.md
54
+ [`Napi::BigInt`]: ./bigint.md
55
+ [`Napi::Boolean`]: ./boolean.md
56
+ [`Napi::Buffer`]: ./buffer.md
57
+ [`Napi::CallbackInfo`]: ./callbackinfo.md
58
+ [`Napi::CallbackScope`]: ./callback_scope.md
59
+ [`Napi::ClassPropertyDescriptor`]: ./class_property_descriptor.md
60
+ [`Napi::DataView`]: ./dataview.md
61
+ [`Napi::Date`]: ./date.md
62
+ [`Napi::Env`]: ./env.md
63
+ [`Napi::Error`]: ./error.md
64
+ [`Napi::EscapableHandleScope`]: ./escapable_handle_scope.md
65
+ [`Napi::External`]: ./external.md
66
+ [`Napi::Function`]: ./function.md
67
+ [`Napi::FunctionReference`]: ./function_reference.md
68
+ [`Napi::HandleScope`]: ./handle_scope.md
69
+ [`Napi::InstanceWrap`]: ./instance_wrap.md
70
+ [`Napi::MemoryManagement`]: ./memory_management.md
71
+ [`Napi::Name`]: ./name.md
72
+ [`Napi::Number`]: ./number.md
73
+ [`Napi::Object`]: ./object.md
74
+ [`Napi::ObjectReference`]: ./object_reference.md
75
+ [`Napi::ObjectWrap`]: ./object_wrap.md
76
+ [`Napi::Promise`]: ./promise.md
77
+ [`Napi::PropertyDescriptor`]: ./property_descriptor.md
78
+ [`Napi::RangeError`]: ./range_error.md
79
+ [`Napi::Reference`]: ./reference.md
80
+ [`Napi::Reference<Napi::Function>`]: ./reference.md
81
+ [`Napi::Reference<Napi::Object>`]: ./reference.md
82
+ [`Napi::String`]: ./string.md
83
+ [`Napi::Symbol`]: ./symbol.md
84
+ [`Napi::ThreadSafeFunction`]: ./thread_safe_function.md
85
+ [`Napi::TypeError`]: ./type_error.md
86
+ [`Napi::TypedArray`]: ./typed_array.md
87
+ [`Napi::TypedArrayOf`]: ./typed_array_of.md
88
+ [`Napi::Uint8Array`]: ./typed_array_of.md
89
+ [`Napi::Value`]: ./value.md
90
+ [`Napi::VersionManagement`]: ./version_management.md
91
+ [`std::exception`]: https://cplusplus.com/reference/exception/exception/
@@ -0,0 +1,408 @@
1
+ # InstanceWrap<T>
2
+
3
+ This class serves as the base class for [`Napi::ObjectWrap<T>`][] and
4
+ [`Napi::Addon<T>`][].
5
+
6
+ In the case of [`Napi::Addon<T>`][] it provides the
7
+ methods for exposing functions to JavaScript on instances of an add-on.
8
+
9
+ As a base class for [`Napi::ObjectWrap<T>`][] it provides the methods for
10
+ exposing instance methods of JavaScript objects instantiated from the JavaScript
11
+ class corresponding to the subclass of [`Napi::ObjectWrap<T>`][].
12
+
13
+ ## Methods
14
+
15
+ ### InstanceMethod
16
+
17
+ Creates a property descriptor that represents a method exposed on JavaScript
18
+ instances of this class.
19
+
20
+ ```cpp
21
+ template <typename T>
22
+ static Napi::ClassPropertyDescriptor<T>
23
+ Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
24
+ InstanceVoidMethodCallback method,
25
+ napi_property_attributes attributes = napi_default,
26
+ void* data = nullptr);
27
+ ```
28
+
29
+ - `[in] utf8name`: Null-terminated string that represents the name of the method
30
+ provided by instances of the class.
31
+ - `[in] method`: The native function that represents a method provided by the
32
+ add-on.
33
+ - `[in] attributes`: The attributes associated with the property. One or more of
34
+ `napi_property_attributes`.
35
+ - `[in] data`: User-provided data passed into the method when it is invoked.
36
+
37
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
38
+ provided by instances of the class. The method must be of the form
39
+
40
+ ```cpp
41
+ void MethodName(const Napi::CallbackInfo& info);
42
+ ```
43
+
44
+ ### InstanceMethod
45
+
46
+ Creates a property descriptor that represents a method exposed on JavaScript
47
+ instances of this class.
48
+
49
+ ```cpp
50
+ template <typename T>
51
+ static Napi::ClassPropertyDescriptor<T>
52
+ Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
53
+ InstanceMethodCallback method,
54
+ napi_property_attributes attributes = napi_default,
55
+ void* data = nullptr);
56
+ ```
57
+
58
+ - `[in] utf8name`: Null-terminated string that represents the name of the method
59
+ provided by instances of the class.
60
+ - `[in] method`: The native function that represents a method provided by the
61
+ add-on.
62
+ - `[in] attributes`: The attributes associated with the property. One or more of
63
+ `napi_property_attributes`.
64
+ - `[in] data`: User-provided data passed into the method when it is invoked.
65
+
66
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
67
+ provided by instances of the class. The method must be of the form
68
+
69
+ ```cpp
70
+ Napi::Value MethodName(const Napi::CallbackInfo& info);
71
+ ```
72
+
73
+ ### InstanceMethod
74
+
75
+ Creates a property descriptor that represents a method exposed on JavaScript
76
+ instances of this class.
77
+
78
+ ```cpp
79
+ template <typename T>
80
+ static Napi::ClassPropertyDescriptor<T>
81
+ Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
82
+ InstanceVoidMethodCallback method,
83
+ napi_property_attributes attributes = napi_default,
84
+ void* data = nullptr);
85
+ ```
86
+
87
+ - `[in] name`: JavaScript symbol that represents the name of the method provided
88
+ by instances of the class.
89
+ - `[in] method`: The native function that represents a method provided by the
90
+ add-on.
91
+ - `[in] attributes`: The attributes associated with the property. One or more of
92
+ `napi_property_attributes`.
93
+ - `[in] data`: User-provided data passed into the method when it is invoked.
94
+
95
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
96
+ provided by instances of the class. The method must be of the form
97
+
98
+ ```cpp
99
+ void MethodName(const Napi::CallbackInfo& info);
100
+ ```
101
+
102
+ ### InstanceMethod
103
+
104
+ Creates a property descriptor that represents a method exposed on JavaScript
105
+ instances of this class.
106
+
107
+ ```cpp
108
+ template <typename T>
109
+ static Napi::ClassPropertyDescriptor<T>
110
+ Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
111
+ InstanceMethodCallback method,
112
+ napi_property_attributes attributes = napi_default,
113
+ void* data = nullptr);
114
+ ```
115
+
116
+ - `[in] name`: JavaScript symbol that represents the name of the method provided
117
+ by instances of the class.
118
+ - `[in] method`: The native function that represents a method provided by the
119
+ add-on.
120
+ - `[in] attributes`: The attributes associated with the property. One or more of
121
+ `napi_property_attributes`.
122
+ - `[in] data`: User-provided data passed into the method when it is invoked.
123
+
124
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
125
+ provided by instances of the class. The method must be of the form
126
+
127
+ ```cpp
128
+ Napi::Value MethodName(const Napi::CallbackInfo& info);
129
+ ```
130
+
131
+ ### InstanceMethod
132
+
133
+ Creates a property descriptor that represents a method exposed on JavaScript
134
+ instances of this class.
135
+
136
+ ```cpp
137
+ <template typename T>
138
+ template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
139
+ static Napi::ClassPropertyDescriptor<T>
140
+ Napi::InstanceWrap::InstanceMethod(const char* utf8name,
141
+ napi_property_attributes attributes = napi_default,
142
+ void* data = nullptr);
143
+ ```
144
+
145
+ - `[in] method`: The native function that represents a method provided by the
146
+ add-on.
147
+ - `[in] utf8name`: Null-terminated string that represents the name of the method
148
+ provided by instances of the class.
149
+ - `[in] attributes`: The attributes associated with the property. One or more of
150
+ `napi_property_attributes`.
151
+ - `[in] data`: User-provided data passed into the method when it is invoked.
152
+
153
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
154
+ provided by instances of the class. The method must be of the form
155
+
156
+ ```cpp
157
+ void MethodName(const Napi::CallbackInfo& info);
158
+ ```
159
+
160
+ ### InstanceMethod
161
+
162
+ Creates a property descriptor that represents a method exposed on JavaScript
163
+ instances of this class.
164
+
165
+ ```cpp
166
+ template <typename T>
167
+ template <typename InstanceWrap<T>::InstanceMethodCallback method>
168
+ static Napi::ClassPropertyDescriptor<T>
169
+ Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
170
+ napi_property_attributes attributes = napi_default,
171
+ void* data = nullptr);
172
+ ```
173
+
174
+ - `[in] method`: The native function that represents a method provided by the
175
+ add-on.
176
+ - `[in] utf8name`: Null-terminated string that represents the name of the method
177
+ provided by instances of the class.
178
+ - `[in] attributes`: The attributes associated with the property. One or more of
179
+ `napi_property_attributes`.
180
+ - `[in] data`: User-provided data passed into the method when it is invoked.
181
+
182
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
183
+ provided by instances of the class. The method must be of the form
184
+
185
+ ```cpp
186
+ Napi::Value MethodName(const Napi::CallbackInfo& info);
187
+ ```
188
+
189
+ ### InstanceMethod
190
+
191
+ Creates a property descriptor that represents a method exposed on JavaScript
192
+ instances of this class.
193
+
194
+ ```cpp
195
+ template <typename T>
196
+ template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
197
+ static Napi::ClassPropertyDescriptor<T>
198
+ Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
199
+ napi_property_attributes attributes = napi_default,
200
+ void* data = nullptr);
201
+ ```
202
+
203
+ - `[in] method`: The native function that represents a method provided by the
204
+ add-on.
205
+ - `[in] name`: The `Napi::Symbol` object whose value is used to identify the
206
+ instance method for the class.
207
+ - `[in] attributes`: The attributes associated with the property. One or more of
208
+ `napi_property_attributes`.
209
+ - `[in] data`: User-provided data passed into the method when it is invoked.
210
+
211
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
212
+ provided by instances of the class. The method must be of the form
213
+
214
+ ```cpp
215
+ void MethodName(const Napi::CallbackInfo& info);
216
+ ```
217
+
218
+ ### InstanceMethod
219
+
220
+ Creates a property descriptor that represents a method exposed on JavaScript
221
+ instances of this class.
222
+
223
+ ```cpp
224
+ template <typename T>
225
+ template <InstanceWrap<T>::InstanceMethodCallback method>
226
+ static Napi::ClassPropertyDescriptor<T>
227
+ Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
228
+ napi_property_attributes attributes = napi_default,
229
+ void* data = nullptr);
230
+ ```
231
+
232
+ - `[in] method`: The native function that represents a method provided by the
233
+ add-on.
234
+ - `[in] name`: The `Napi::Symbol` object whose value is used to identify the
235
+ instance method for the class.
236
+ - `[in] attributes`: The attributes associated with the property. One or more of
237
+ `napi_property_attributes`.
238
+ - `[in] data`: User-provided data passed into the method when it is invoked.
239
+
240
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
241
+ provided by instances of the class. The method must be of the form
242
+
243
+ ```cpp
244
+ Napi::Value MethodName(const Napi::CallbackInfo& info);
245
+ ```
246
+
247
+ ### InstanceAccessor
248
+
249
+ Creates a property descriptor that represents a property exposed on JavaScript
250
+ instances of this class.
251
+
252
+ ```cpp
253
+ template <typename T>
254
+ static Napi::ClassPropertyDescriptor<T>
255
+ Napi::InstanceWrap<T>::InstanceAccessor(const char* utf8name,
256
+ InstanceGetterCallback getter,
257
+ InstanceSetterCallback setter,
258
+ napi_property_attributes attributes = napi_default,
259
+ void* data = nullptr);
260
+ ```
261
+
262
+ - `[in] utf8name`: Null-terminated string that represents the name of the method
263
+ provided by instances of the class.
264
+ - `[in] getter`: The native function to call when a get access to the property
265
+ is performed.
266
+ - `[in] setter`: The native function to call when a set access to the property
267
+ is performed.
268
+ - `[in] attributes`: The attributes associated with the property. One or more of
269
+ `napi_property_attributes`.
270
+ - `[in] data`: User-provided data passed into the getter or the setter when it
271
+ is invoked.
272
+
273
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
274
+ accessor property provided by instances of the class.
275
+
276
+ ### InstanceAccessor
277
+
278
+ Creates a property descriptor that represents a property exposed on JavaScript
279
+ instances of this class.
280
+
281
+ ```cpp
282
+ template <typename T>
283
+ static Napi::ClassPropertyDescriptor<T>
284
+ Napi::InstanceWrap<T>::InstanceAccessor(Symbol name,
285
+ InstanceGetterCallback getter,
286
+ InstanceSetterCallback setter,
287
+ napi_property_attributes attributes = napi_default,
288
+ void* data = nullptr);
289
+ ```
290
+
291
+ - `[in] name`: The `Napi::Symbol` object whose value is used to identify the
292
+ instance accessor.
293
+ - `[in] getter`: The native function to call when a get access to the property of
294
+ a JavaScript class is performed.
295
+ - `[in] setter`: The native function to call when a set access to the property of
296
+ a JavaScript class is performed.
297
+ - `[in] attributes`: The attributes associated with the property. One or more of
298
+ `napi_property_attributes`.
299
+ - `[in] data`: User-provided data passed into the getter or the setter when it
300
+ is invoked.
301
+
302
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
303
+ accessor property provided instances of the class.
304
+
305
+ ### InstanceAccessor
306
+
307
+ Creates a property descriptor that represents a property exposed on JavaScript
308
+ instances of this class.
309
+
310
+ ```cpp
311
+ template <typename T>
312
+ template <typename InstanceWrap<T>::InstanceGetterCallback getter,
313
+ typename InstanceWrap<T>::InstanceSetterCallback setter=nullptr>
314
+ static Napi::ClassPropertyDescriptor<T>
315
+ Napi::InstanceWrap<T>::InstanceAccessor(const char* utf8name,
316
+ napi_property_attributes attributes = napi_default,
317
+ void* data = nullptr);
318
+ ```
319
+
320
+ - `[in] getter`: The native function to call when a get access to the property of
321
+ a JavaScript class is performed.
322
+ - `[in] setter`: The native function to call when a set access to the property of
323
+ a JavaScript class is performed.
324
+ - `[in] utf8name`: Null-terminated string that represents the name of the method
325
+ provided by instances of the class.
326
+ - `[in] attributes`: The attributes associated with the property. One or more of
327
+ `napi_property_attributes`.
328
+ - `[in] data`: User-provided data passed into the getter or the setter when it
329
+ is invoked.
330
+
331
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
332
+ accessor property provided by instances of the class.
333
+
334
+ ### InstanceAccessor
335
+
336
+ Creates a property descriptor that represents a property exposed on JavaScript
337
+ instances of this class.
338
+
339
+ ```cpp
340
+ template <typename T>
341
+ template <typename InstanceWrap<T>::InstanceGetterCallback getter,
342
+ typename InstanceWrap<T>::InstanceSetterCallback setter=nullptr>
343
+ static Napi::ClassPropertyDescriptor<T>
344
+ Napi::InstanceWrap<T>::InstanceAccessor(Symbol name,
345
+ napi_property_attributes attributes = napi_default,
346
+ void* data = nullptr);
347
+ ```
348
+
349
+ - `[in] getter`: The native function to call when a get access to the property of
350
+ a JavaScript class is performed.
351
+ - `[in] setter`: The native function to call when a set access to the property of
352
+ a JavaScript class is performed.
353
+ - `[in] name`: The `Napi::Symbol` object whose value is used to identify the
354
+ instance accessor.
355
+ - `[in] attributes`: The attributes associated with the property. One or more of
356
+ `napi_property_attributes`.
357
+ - `[in] data`: User-provided data passed into the getter or the setter when it
358
+ is invoked.
359
+
360
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
361
+ accessor property provided by instances of the class.
362
+
363
+ ### InstanceValue
364
+
365
+ Creates property descriptor that represents a value exposed on JavaScript
366
+ instances of this class.
367
+
368
+ ```cpp
369
+ template <typename T>
370
+ static Napi::ClassPropertyDescriptor<T>
371
+ Napi::InstanceWrap<T>::InstanceValue(const char* utf8name,
372
+ Napi::Value value,
373
+ napi_property_attributes attributes = napi_default);
374
+ ```
375
+
376
+ - `[in] utf8name`: Null-terminated string that represents the name of the
377
+ property.
378
+ - `[in] value`: The value that's retrieved by a get access of the property.
379
+ - `[in] attributes`: The attributes associated with the property. One or more of
380
+ `napi_property_attributes`.
381
+
382
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
383
+ value property of an add-on.
384
+
385
+ ### InstanceValue
386
+
387
+ Creates property descriptor that represents a value exposed on JavaScript
388
+ instances of this class.
389
+
390
+ ```cpp
391
+ template <typename T>
392
+ static Napi::ClassPropertyDescriptor<T>
393
+ Napi::InstanceWrap<T>::InstanceValue(Symbol name,
394
+ Napi::Value value,
395
+ napi_property_attributes attributes = napi_default);
396
+ ```
397
+
398
+ - `[in] name`: The `Napi::Symbol` object whose value is used to identify the
399
+ name of the property.
400
+ - `[in] value`: The value that's retrieved by a get access of the property.
401
+ - `[in] attributes`: The attributes associated with the property. One or more of
402
+ `napi_property_attributes`.
403
+
404
+ Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
405
+ value property of an add-on.
406
+
407
+ [`Napi::Addon<T>`]: ./addon.md
408
+ [`Napi::ObjectWrap<T>`]: ./object_wrap.md
@@ -0,0 +1,76 @@
1
+ # Maybe (template)
2
+
3
+ Class `Napi::Maybe<T>` represents a value that may be empty: every `Maybe` is
4
+ either `Just` and contains a value, or `Nothing`, and does not. `Maybe` types
5
+ are very common in node-addon-api code, as they represent that the function may
6
+ throw a JavaScript exception and cause the program to be unable to evaluate any
7
+ JavaScript code until the exception has been handled.
8
+
9
+ Typically, the value wrapped in `Napi::Maybe<T>` is [`Napi::Value`] and its
10
+ subclasses.
11
+
12
+ ## Methods
13
+
14
+ ### IsNothing
15
+
16
+ ```cpp
17
+ template <typename T>
18
+ bool Napi::Maybe::IsNothing() const;
19
+ ```
20
+
21
+ Returns `true` if the `Maybe` is `Nothing` and does not contain a value, and
22
+ `false` otherwise.
23
+
24
+ ### IsJust
25
+
26
+ ```cpp
27
+ template <typename T>
28
+ bool Napi::Maybe::IsJust() const;
29
+ ```
30
+
31
+ Returns `true` if the `Maybe` is `Just` and contains a value, and `false`
32
+ otherwise.
33
+
34
+ ### Check
35
+
36
+ ```cpp
37
+ template <typename T>
38
+ void Napi::Maybe::Check() const;
39
+ ```
40
+
41
+ Short-hand for `Maybe::Unwrap()`, which doesn't return a value. Could be used
42
+ where the actual value of the Maybe is not needed like `Object::Set`.
43
+ If this Maybe is nothing (empty), node-addon-api will crash the
44
+ process.
45
+
46
+ ### Unwrap
47
+
48
+ ```cpp
49
+ template <typename T>
50
+ T Napi::Maybe::Unwrap() const;
51
+ ```
52
+
53
+ Return the value of type `T` contained in the Maybe. If this Maybe is
54
+ nothing (empty), node-addon-api will crash the process.
55
+
56
+ ### UnwrapOr
57
+
58
+ ```cpp
59
+ template <typename T>
60
+ T Napi::Maybe::UnwrapOr(const T& default_value) const;
61
+ ```
62
+
63
+ Return the value of type T contained in the Maybe, or use a default
64
+ value if this Maybe is nothing (empty).
65
+
66
+ ### UnwrapTo
67
+
68
+ ```cpp
69
+ template <typename T>
70
+ bool Napi::Maybe::UnwrapTo(T* result) const;
71
+ ```
72
+
73
+ Converts this Maybe to a value of type `T` in the `out`. If this Maybe is
74
+ nothing (empty), `false` is returned and `out` is left untouched.
75
+
76
+ [`Napi::Value`]: ./value.md
@@ -0,0 +1,27 @@
1
+ # MemoryManagement
2
+
3
+ The `Napi::MemoryManagement` class contains functions that give the JavaScript engine
4
+ an indication of the amount of externally allocated memory that is kept alive by
5
+ JavaScript objects.
6
+
7
+ ## Methods
8
+
9
+ ### AdjustExternalMemory
10
+
11
+ The function `AdjustExternalMemory` adjusts the amount of registered external
12
+ memory used to give the JavaScript engine an indication of the amount of externally
13
+ allocated memory that is kept alive by JavaScript objects.
14
+ The JavaScript engine uses this to decide when to perform global garbage collections.
15
+ Registering externally allocated memory will trigger global garbage collections
16
+ more often than it would otherwise in an attempt to garbage collect the JavaScript
17
+ objects that keep the externally allocated memory alive.
18
+
19
+ ```cpp
20
+ static int64_t Napi::MemoryManagement::AdjustExternalMemory(Napi::Env env, int64_t change_in_bytes);
21
+ ```
22
+
23
+ - `[in] env`: The environment in which the API is invoked under.
24
+ - `[in] change_in_bytes`: The change in externally allocated memory that is kept
25
+ alive by JavaScript objects expressed in bytes.
26
+
27
+ Returns the adjusted memory value.
@@ -0,0 +1,29 @@
1
+ # Name
2
+
3
+ Class `Napi::Name` inherits from class [`Napi::Value`][].
4
+
5
+ Names are JavaScript values that can be used as a property name. There are two
6
+ specialized types of names supported in Node.js Addon API [`Napi::String`](string.md)
7
+ and [`Napi::Symbol`](symbol.md).
8
+
9
+ ## Methods
10
+
11
+ ### Constructor
12
+ ```cpp
13
+ Napi::Name::Name();
14
+ ```
15
+
16
+ Returns an empty `Napi::Name`.
17
+
18
+ ```cpp
19
+ Napi::Name::Name(napi_env env, napi_value value);
20
+ ```
21
+ - `[in] env` - The environment in which to create the array.
22
+ - `[in] value` - The primitive to wrap.
23
+
24
+ Returns a `Napi::Name` created from the JavaScript primitive.
25
+
26
+ Note:
27
+ The value is not coerced to a string.
28
+
29
+ [`Napi::Value`]: ./value.md