koffi 2.16.0-beta.2 → 2.16.1

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 (425) hide show
  1. package/CHANGELOG.md +66 -0
  2. package/build/koffi/darwin_arm64/koffi.node +0 -0
  3. package/build/koffi/darwin_x64/koffi.node +0 -0
  4. package/build/koffi/freebsd_arm64/koffi.node +0 -0
  5. package/build/koffi/freebsd_ia32/koffi.node +0 -0
  6. package/build/koffi/freebsd_x64/koffi.node +0 -0
  7. package/build/koffi/linux_arm64/koffi.node +0 -0
  8. package/build/koffi/linux_armhf/koffi.node +0 -0
  9. package/build/koffi/linux_ia32/koffi.node +0 -0
  10. package/build/koffi/linux_loong64/koffi.node +0 -0
  11. package/build/koffi/linux_riscv64d/koffi.node +0 -0
  12. package/build/koffi/linux_x64/koffi.node +0 -0
  13. package/build/koffi/musl_arm64/koffi.node +0 -0
  14. package/build/koffi/musl_x64/koffi.node +0 -0
  15. package/build/koffi/openbsd_ia32/koffi.node +0 -0
  16. package/build/koffi/openbsd_x64/koffi.node +0 -0
  17. package/build/koffi/win32_arm64/koffi.exp +0 -0
  18. package/build/koffi/win32_arm64/koffi.lib +0 -0
  19. package/build/koffi/win32_arm64/koffi.node +0 -0
  20. package/build/koffi/win32_ia32/koffi.exp +0 -0
  21. package/build/koffi/win32_ia32/koffi.lib +0 -0
  22. package/build/koffi/win32_ia32/koffi.node +0 -0
  23. package/build/koffi/win32_x64/koffi.exp +0 -0
  24. package/build/koffi/win32_x64/koffi.lib +0 -0
  25. package/build/koffi/win32_x64/koffi.node +0 -0
  26. package/index.d.ts +9 -11
  27. package/index.js +6 -9
  28. package/indirect.js +6 -9
  29. package/lib/native/base/base.cc +1 -6
  30. package/package.json +3 -3
  31. package/src/cnoke/assets/FindCNoke.cmake +27 -16
  32. package/src/cnoke/assets/toolchains.json +126 -0
  33. package/src/cnoke/cnoke.js +27 -33
  34. package/src/cnoke/src/builder.js +124 -63
  35. package/src/cnoke/src/tools.js +1 -5
  36. package/src/koffi/CMakeLists.txt +32 -21
  37. package/src/koffi/src/{abi/arm32.cc → abi_arm32.cc} +235 -246
  38. package/src/koffi/src/{abi/arm32_asm.S → abi_arm32_asm.S} +19 -15
  39. package/src/koffi/src/{abi/arm64.cc → abi_arm64.cc} +253 -300
  40. package/src/koffi/src/{abi/arm64_asm.S → abi_arm64_asm.S} +16 -10
  41. package/src/koffi/src/{abi/arm64_asm.asm → abi_arm64_asm.asm} +17 -10
  42. package/src/koffi/src/{abi/loong64_asm.S → abi_loong64_asm.S} +16 -10
  43. package/src/koffi/src/{abi/riscv64.cc → abi_riscv64.cc} +233 -244
  44. package/src/koffi/src/{abi/riscv64_asm.S → abi_riscv64_asm.S} +16 -10
  45. package/src/koffi/src/{abi/x64_sysv.cc → abi_x64_sysv.cc} +208 -220
  46. package/src/koffi/src/{abi/x64_sysv_asm.S → abi_x64_sysv_asm.S} +17 -10
  47. package/src/koffi/src/{abi/x64_win.cc → abi_x64_win.cc} +175 -230
  48. package/src/koffi/src/{abi/x64_win_asm.S → abi_x64_win_asm.S} +49 -27
  49. package/src/koffi/src/{abi/x64_win_asm.asm → abi_x64_win_asm.asm} +54 -27
  50. package/src/koffi/src/{abi/x86.cc → abi_x86.cc} +187 -252
  51. package/src/koffi/src/{abi/x86_asm.S → abi_x86_asm.S} +38 -21
  52. package/src/koffi/src/{abi/x86_asm.asm → abi_x86_asm.asm} +33 -16
  53. package/src/koffi/src/call.cc +475 -290
  54. package/src/koffi/src/call.hh +15 -18
  55. package/src/koffi/src/ffi.cc +195 -184
  56. package/src/koffi/src/ffi.hh +60 -16
  57. package/src/koffi/src/init.js +1 -0
  58. package/src/koffi/src/util.cc +113 -159
  59. package/src/koffi/src/util.hh +23 -74
  60. package/src/koffi/src/win32.cc +13 -0
  61. package/src/koffi/src/win32.hh +7 -0
  62. package/src/koffi/tools/write_trampolines.js +77 -0
  63. package/doc/README.md +0 -27
  64. package/doc/assets.ini +0 -24
  65. package/doc/build.sh +0 -9
  66. package/doc/develop.sh +0 -15
  67. package/doc/pages/404.md +0 -17
  68. package/doc/pages.ini +0 -86
  69. package/doc/static/highlight.js +0 -8
  70. package/doc/static/koffi.css +0 -11
  71. package/doc/static/koffi.png +0 -0
  72. package/doc/static/logo.webp +0 -0
  73. package/doc/static/perf_linux.png +0 -0
  74. package/doc/static/perf_windows.png +0 -0
  75. package/doc/static/print.css +0 -10
  76. package/doc/templates/code.html +0 -48
  77. package/doc/templates/page.html +0 -47
  78. package/src/koffi/cmake/raylib.cmake +0 -85
  79. package/src/koffi/cmake/sqlite3.cmake +0 -9
  80. package/src/koffi/examples/electron-builder/README.md +0 -11
  81. package/src/koffi/examples/electron-builder/package.json +0 -21
  82. package/src/koffi/examples/electron-builder/src/app.js +0 -20
  83. package/src/koffi/examples/electron-builder/src/index.html +0 -143
  84. package/src/koffi/examples/electron-builder/src/preload.js +0 -5
  85. package/src/koffi/examples/electron-forge/README.md +0 -25
  86. package/src/koffi/examples/electron-forge/forge.config.js +0 -63
  87. package/src/koffi/examples/electron-forge/package.json +0 -39
  88. package/src/koffi/examples/electron-forge/src/index.css +0 -7
  89. package/src/koffi/examples/electron-forge/src/index.html +0 -143
  90. package/src/koffi/examples/electron-forge/src/main.js +0 -52
  91. package/src/koffi/examples/electron-forge/src/preload.js +0 -5
  92. package/src/koffi/examples/electron-forge/src/renderer.js +0 -31
  93. package/src/koffi/examples/electron-forge/webpack.main.config.js +0 -11
  94. package/src/koffi/examples/electron-forge/webpack.renderer.config.js +0 -13
  95. package/src/koffi/examples/electron-forge/webpack.rules.js +0 -35
  96. package/src/koffi/examples/node-esbuild/README.md +0 -19
  97. package/src/koffi/examples/node-esbuild/index.js +0 -2
  98. package/src/koffi/examples/node-esbuild/package.json +0 -16
  99. package/src/koffi/examples/nwjs/README.md +0 -20
  100. package/src/koffi/examples/nwjs/package.json +0 -11
  101. package/src/koffi/examples/nwjs/src/index.html +0 -145
  102. package/src/koffi/examples/nwjs/src/package.json +0 -10
  103. package/src/koffi/examples/yao-pkg/README.md +0 -17
  104. package/src/koffi/examples/yao-pkg/index.js +0 -2
  105. package/src/koffi/examples/yao-pkg/package.json +0 -22
  106. package/src/koffi/src/primitives.inc +0 -39
  107. package/src/koffi/src/trampolines/armasm.inc +0 -32771
  108. package/src/koffi/src/trampolines/gnu.inc +0 -24577
  109. package/src/koffi/src/trampolines/masm32.inc +0 -32769
  110. package/src/koffi/src/trampolines/masm64.inc +0 -32769
  111. package/src/koffi/src/trampolines/prototypes.inc +0 -16388
  112. package/vendor/node-addon-api/CHANGELOG.md +0 -1272
  113. package/vendor/node-addon-api/CODE_OF_CONDUCT.md +0 -4
  114. package/vendor/node-addon-api/CONTRIBUTING.md +0 -203
  115. package/vendor/node-addon-api/appveyor.yml +0 -37
  116. package/vendor/node-addon-api/benchmark/README.md +0 -47
  117. package/vendor/node-addon-api/benchmark/binding.gyp +0 -25
  118. package/vendor/node-addon-api/benchmark/function_args.cc +0 -250
  119. package/vendor/node-addon-api/benchmark/function_args.js +0 -60
  120. package/vendor/node-addon-api/benchmark/index.js +0 -34
  121. package/vendor/node-addon-api/benchmark/property_descriptor.cc +0 -84
  122. package/vendor/node-addon-api/benchmark/property_descriptor.js +0 -38
  123. package/vendor/node-addon-api/common.gypi +0 -21
  124. package/vendor/node-addon-api/doc/README.md +0 -145
  125. package/vendor/node-addon-api/doc/addon.md +0 -163
  126. package/vendor/node-addon-api/doc/array.md +0 -81
  127. package/vendor/node-addon-api/doc/array_buffer.md +0 -165
  128. package/vendor/node-addon-api/doc/async_context.md +0 -86
  129. package/vendor/node-addon-api/doc/async_operations.md +0 -31
  130. package/vendor/node-addon-api/doc/async_worker.md +0 -428
  131. package/vendor/node-addon-api/doc/async_worker_variants.md +0 -578
  132. package/vendor/node-addon-api/doc/basic_env.md +0 -200
  133. package/vendor/node-addon-api/doc/bigint.md +0 -97
  134. package/vendor/node-addon-api/doc/boolean.md +0 -68
  135. package/vendor/node-addon-api/doc/buffer.md +0 -245
  136. package/vendor/node-addon-api/doc/callback_scope.md +0 -54
  137. package/vendor/node-addon-api/doc/callbackinfo.md +0 -97
  138. package/vendor/node-addon-api/doc/checker-tool.md +0 -32
  139. package/vendor/node-addon-api/doc/class_property_descriptor.md +0 -123
  140. package/vendor/node-addon-api/doc/cmake-js.md +0 -87
  141. package/vendor/node-addon-api/doc/contributing/creating_a_release.md +0 -95
  142. package/vendor/node-addon-api/doc/conversion-tool.md +0 -28
  143. package/vendor/node-addon-api/doc/dataview.md +0 -248
  144. package/vendor/node-addon-api/doc/date.md +0 -68
  145. package/vendor/node-addon-api/doc/env.md +0 -87
  146. package/vendor/node-addon-api/doc/error.md +0 -120
  147. package/vendor/node-addon-api/doc/error_handling.md +0 -266
  148. package/vendor/node-addon-api/doc/escapable_handle_scope.md +0 -80
  149. package/vendor/node-addon-api/doc/external.md +0 -79
  150. package/vendor/node-addon-api/doc/external_buffer.md +0 -18
  151. package/vendor/node-addon-api/doc/finalization.md +0 -153
  152. package/vendor/node-addon-api/doc/function.md +0 -402
  153. package/vendor/node-addon-api/doc/function_reference.md +0 -238
  154. package/vendor/node-addon-api/doc/generator.md +0 -13
  155. package/vendor/node-addon-api/doc/handle_scope.md +0 -77
  156. package/vendor/node-addon-api/doc/hierarchy.md +0 -95
  157. package/vendor/node-addon-api/doc/instance_wrap.md +0 -408
  158. package/vendor/node-addon-api/doc/maybe.md +0 -76
  159. package/vendor/node-addon-api/doc/memory_management.md +0 -27
  160. package/vendor/node-addon-api/doc/name.md +0 -29
  161. package/vendor/node-addon-api/doc/node-gyp.md +0 -82
  162. package/vendor/node-addon-api/doc/number.md +0 -163
  163. package/vendor/node-addon-api/doc/object.md +0 -411
  164. package/vendor/node-addon-api/doc/object_lifetime_management.md +0 -83
  165. package/vendor/node-addon-api/doc/object_reference.md +0 -117
  166. package/vendor/node-addon-api/doc/object_wrap.md +0 -604
  167. package/vendor/node-addon-api/doc/prebuild_tools.md +0 -16
  168. package/vendor/node-addon-api/doc/promises.md +0 -130
  169. package/vendor/node-addon-api/doc/property_descriptor.md +0 -286
  170. package/vendor/node-addon-api/doc/propertylvalue.md +0 -50
  171. package/vendor/node-addon-api/doc/range_error.md +0 -59
  172. package/vendor/node-addon-api/doc/reference.md +0 -113
  173. package/vendor/node-addon-api/doc/setup.md +0 -115
  174. package/vendor/node-addon-api/doc/string.md +0 -93
  175. package/vendor/node-addon-api/doc/symbol.md +0 -61
  176. package/vendor/node-addon-api/doc/syntax_error.md +0 -66
  177. package/vendor/node-addon-api/doc/threadsafe.md +0 -121
  178. package/vendor/node-addon-api/doc/threadsafe_function.md +0 -290
  179. package/vendor/node-addon-api/doc/type_error.md +0 -59
  180. package/vendor/node-addon-api/doc/type_taggable.md +0 -40
  181. package/vendor/node-addon-api/doc/typed_array.md +0 -78
  182. package/vendor/node-addon-api/doc/typed_array_of.md +0 -137
  183. package/vendor/node-addon-api/doc/typed_threadsafe_function.md +0 -306
  184. package/vendor/node-addon-api/doc/value.md +0 -368
  185. package/vendor/node-addon-api/doc/version_management.md +0 -43
  186. package/vendor/node-addon-api/eslint.config.js +0 -5
  187. package/vendor/node-addon-api/except.gypi +0 -25
  188. package/vendor/node-addon-api/index.js +0 -14
  189. package/vendor/node-addon-api/node_addon_api.gyp +0 -42
  190. package/vendor/node-addon-api/node_api.gyp +0 -9
  191. package/vendor/node-addon-api/noexcept.gypi +0 -26
  192. package/vendor/node-addon-api/nothing.c +0 -0
  193. package/vendor/node-addon-api/package-support.json +0 -21
  194. package/vendor/node-addon-api/package.json +0 -480
  195. package/vendor/node-addon-api/release-please-config.json +0 -15
  196. package/vendor/node-addon-api/test/README.md +0 -91
  197. package/vendor/node-addon-api/test/addon.cc +0 -44
  198. package/vendor/node-addon-api/test/addon.js +0 -7
  199. package/vendor/node-addon-api/test/addon_build/index.js +0 -49
  200. package/vendor/node-addon-api/test/addon_build/tpl/addon.cc +0 -18
  201. package/vendor/node-addon-api/test/addon_build/tpl/binding.gyp +0 -63
  202. package/vendor/node-addon-api/test/addon_build/tpl/index.js +0 -9
  203. package/vendor/node-addon-api/test/addon_build/tpl/package.json +0 -11
  204. package/vendor/node-addon-api/test/addon_data.cc +0 -98
  205. package/vendor/node-addon-api/test/addon_data.js +0 -24
  206. package/vendor/node-addon-api/test/array_buffer.cc +0 -243
  207. package/vendor/node-addon-api/test/array_buffer.js +0 -70
  208. package/vendor/node-addon-api/test/async_context.cc +0 -36
  209. package/vendor/node-addon-api/test/async_context.js +0 -122
  210. package/vendor/node-addon-api/test/async_progress_queue_worker.cc +0 -248
  211. package/vendor/node-addon-api/test/async_progress_queue_worker.js +0 -180
  212. package/vendor/node-addon-api/test/async_progress_worker.cc +0 -357
  213. package/vendor/node-addon-api/test/async_progress_worker.js +0 -200
  214. package/vendor/node-addon-api/test/async_worker.cc +0 -341
  215. package/vendor/node-addon-api/test/async_worker.js +0 -264
  216. package/vendor/node-addon-api/test/async_worker_nocallback.js +0 -19
  217. package/vendor/node-addon-api/test/async_worker_persistent.cc +0 -63
  218. package/vendor/node-addon-api/test/async_worker_persistent.js +0 -24
  219. package/vendor/node-addon-api/test/basic_types/array.cc +0 -40
  220. package/vendor/node-addon-api/test/basic_types/array.js +0 -34
  221. package/vendor/node-addon-api/test/basic_types/boolean.cc +0 -40
  222. package/vendor/node-addon-api/test/basic_types/boolean.js +0 -34
  223. package/vendor/node-addon-api/test/basic_types/number.cc +0 -105
  224. package/vendor/node-addon-api/test/basic_types/number.js +0 -115
  225. package/vendor/node-addon-api/test/basic_types/value.cc +0 -177
  226. package/vendor/node-addon-api/test/basic_types/value.js +0 -173
  227. package/vendor/node-addon-api/test/bigint.cc +0 -91
  228. package/vendor/node-addon-api/test/bigint.js +0 -53
  229. package/vendor/node-addon-api/test/binding-swallowexcept.cc +0 -12
  230. package/vendor/node-addon-api/test/binding.cc +0 -200
  231. package/vendor/node-addon-api/test/binding.gyp +0 -160
  232. package/vendor/node-addon-api/test/buffer.cc +0 -185
  233. package/vendor/node-addon-api/test/buffer.h +0 -26
  234. package/vendor/node-addon-api/test/buffer.js +0 -150
  235. package/vendor/node-addon-api/test/buffer_new_or_copy-inl.h +0 -68
  236. package/vendor/node-addon-api/test/buffer_no_external.cc +0 -24
  237. package/vendor/node-addon-api/test/callbackInfo.cc +0 -27
  238. package/vendor/node-addon-api/test/callbackInfo.js +0 -9
  239. package/vendor/node-addon-api/test/callbackscope.cc +0 -39
  240. package/vendor/node-addon-api/test/callbackscope.js +0 -49
  241. package/vendor/node-addon-api/test/child_processes/addon.js +0 -11
  242. package/vendor/node-addon-api/test/child_processes/addon_data.js +0 -24
  243. package/vendor/node-addon-api/test/child_processes/objectwrap_function.js +0 -22
  244. package/vendor/node-addon-api/test/child_processes/threadsafe_function_exception.js +0 -33
  245. package/vendor/node-addon-api/test/child_processes/typed_threadsafe_function_exception.js +0 -19
  246. package/vendor/node-addon-api/test/common/index.js +0 -246
  247. package/vendor/node-addon-api/test/common/test_helper.h +0 -71
  248. package/vendor/node-addon-api/test/dataview/dataview.cc +0 -48
  249. package/vendor/node-addon-api/test/dataview/dataview.js +0 -35
  250. package/vendor/node-addon-api/test/dataview/dataview_read_write.cc +0 -115
  251. package/vendor/node-addon-api/test/dataview/dataview_read_write.js +0 -92
  252. package/vendor/node-addon-api/test/date.cc +0 -45
  253. package/vendor/node-addon-api/test/date.js +0 -18
  254. package/vendor/node-addon-api/test/env_cleanup.cc +0 -100
  255. package/vendor/node-addon-api/test/env_cleanup.js +0 -55
  256. package/vendor/node-addon-api/test/env_misc.cc +0 -25
  257. package/vendor/node-addon-api/test/env_misc.js +0 -12
  258. package/vendor/node-addon-api/test/error.cc +0 -436
  259. package/vendor/node-addon-api/test/error.js +0 -111
  260. package/vendor/node-addon-api/test/error_handling_for_primitives.cc +0 -13
  261. package/vendor/node-addon-api/test/error_handling_for_primitives.js +0 -29
  262. package/vendor/node-addon-api/test/error_terminating_environment.js +0 -99
  263. package/vendor/node-addon-api/test/except_all.cc +0 -22
  264. package/vendor/node-addon-api/test/except_all.js +0 -14
  265. package/vendor/node-addon-api/test/exports.js +0 -19
  266. package/vendor/node-addon-api/test/external.cc +0 -85
  267. package/vendor/node-addon-api/test/external.js +0 -85
  268. package/vendor/node-addon-api/test/finalizer_order.cc +0 -152
  269. package/vendor/node-addon-api/test/finalizer_order.js +0 -98
  270. package/vendor/node-addon-api/test/function.cc +0 -338
  271. package/vendor/node-addon-api/test/function.js +0 -137
  272. package/vendor/node-addon-api/test/function_reference.cc +0 -204
  273. package/vendor/node-addon-api/test/function_reference.js +0 -157
  274. package/vendor/node-addon-api/test/globalObject/global_object.cc +0 -61
  275. package/vendor/node-addon-api/test/globalObject/global_object_delete_property.cc +0 -31
  276. package/vendor/node-addon-api/test/globalObject/global_object_delete_property.js +0 -58
  277. package/vendor/node-addon-api/test/globalObject/global_object_get_property.cc +0 -40
  278. package/vendor/node-addon-api/test/globalObject/global_object_get_property.js +0 -56
  279. package/vendor/node-addon-api/test/globalObject/global_object_has_own_property.cc +0 -28
  280. package/vendor/node-addon-api/test/globalObject/global_object_has_own_property.js +0 -46
  281. package/vendor/node-addon-api/test/globalObject/global_object_set_property.cc +0 -31
  282. package/vendor/node-addon-api/test/globalObject/global_object_set_property.js +0 -56
  283. package/vendor/node-addon-api/test/handlescope.cc +0 -86
  284. package/vendor/node-addon-api/test/handlescope.js +0 -16
  285. package/vendor/node-addon-api/test/index.js +0 -160
  286. package/vendor/node-addon-api/test/maybe/check.cc +0 -69
  287. package/vendor/node-addon-api/test/maybe/index.js +0 -50
  288. package/vendor/node-addon-api/test/memory_management.cc +0 -18
  289. package/vendor/node-addon-api/test/memory_management.js +0 -9
  290. package/vendor/node-addon-api/test/movable_callbacks.cc +0 -23
  291. package/vendor/node-addon-api/test/movable_callbacks.js +0 -21
  292. package/vendor/node-addon-api/test/name.cc +0 -110
  293. package/vendor/node-addon-api/test/name.js +0 -59
  294. package/vendor/node-addon-api/test/napi_child.js +0 -14
  295. package/vendor/node-addon-api/test/object/delete_property.cc +0 -38
  296. package/vendor/node-addon-api/test/object/delete_property.js +0 -41
  297. package/vendor/node-addon-api/test/object/finalizer.cc +0 -30
  298. package/vendor/node-addon-api/test/object/finalizer.js +0 -28
  299. package/vendor/node-addon-api/test/object/get_property.cc +0 -34
  300. package/vendor/node-addon-api/test/object/get_property.js +0 -40
  301. package/vendor/node-addon-api/test/object/has_own_property.cc +0 -34
  302. package/vendor/node-addon-api/test/object/has_own_property.js +0 -34
  303. package/vendor/node-addon-api/test/object/has_property.cc +0 -38
  304. package/vendor/node-addon-api/test/object/has_property.js +0 -37
  305. package/vendor/node-addon-api/test/object/object.cc +0 -430
  306. package/vendor/node-addon-api/test/object/object.js +0 -218
  307. package/vendor/node-addon-api/test/object/object_deprecated.cc +0 -70
  308. package/vendor/node-addon-api/test/object/object_deprecated.js +0 -42
  309. package/vendor/node-addon-api/test/object/object_freeze_seal.cc +0 -25
  310. package/vendor/node-addon-api/test/object/object_freeze_seal.js +0 -61
  311. package/vendor/node-addon-api/test/object/set_property.cc +0 -45
  312. package/vendor/node-addon-api/test/object/set_property.js +0 -30
  313. package/vendor/node-addon-api/test/object/subscript_operator.cc +0 -58
  314. package/vendor/node-addon-api/test/object/subscript_operator.js +0 -17
  315. package/vendor/node-addon-api/test/object_reference.cc +0 -417
  316. package/vendor/node-addon-api/test/object_reference.js +0 -262
  317. package/vendor/node-addon-api/test/objectwrap.cc +0 -295
  318. package/vendor/node-addon-api/test/objectwrap.js +0 -309
  319. package/vendor/node-addon-api/test/objectwrap_constructor_exception.cc +0 -26
  320. package/vendor/node-addon-api/test/objectwrap_constructor_exception.js +0 -18
  321. package/vendor/node-addon-api/test/objectwrap_function.cc +0 -43
  322. package/vendor/node-addon-api/test/objectwrap_function.js +0 -6
  323. package/vendor/node-addon-api/test/objectwrap_multiple_inheritance.cc +0 -30
  324. package/vendor/node-addon-api/test/objectwrap_multiple_inheritance.js +0 -13
  325. package/vendor/node-addon-api/test/objectwrap_removewrap.cc +0 -45
  326. package/vendor/node-addon-api/test/objectwrap_removewrap.js +0 -32
  327. package/vendor/node-addon-api/test/objectwrap_worker_thread.js +0 -20
  328. package/vendor/node-addon-api/test/promise.cc +0 -111
  329. package/vendor/node-addon-api/test/promise.js +0 -43
  330. package/vendor/node-addon-api/test/reference.cc +0 -78
  331. package/vendor/node-addon-api/test/reference.js +0 -20
  332. package/vendor/node-addon-api/test/require_basic_finalizers/index.js +0 -38
  333. package/vendor/node-addon-api/test/require_basic_finalizers/tpl/addon.cc +0 -12
  334. package/vendor/node-addon-api/test/require_basic_finalizers/tpl/binding.gyp +0 -48
  335. package/vendor/node-addon-api/test/require_basic_finalizers/tpl/index.js +0 -3
  336. package/vendor/node-addon-api/test/require_basic_finalizers/tpl/package.json +0 -11
  337. package/vendor/node-addon-api/test/run_script.cc +0 -56
  338. package/vendor/node-addon-api/test/run_script.js +0 -45
  339. package/vendor/node-addon-api/test/symbol.cc +0 -79
  340. package/vendor/node-addon-api/test/symbol.js +0 -66
  341. package/vendor/node-addon-api/test/testUtil.js +0 -54
  342. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function.cc +0 -230
  343. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function.js +0 -225
  344. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ctx.cc +0 -155
  345. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ctx.js +0 -13
  346. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_exception.cc +0 -50
  347. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_exception.js +0 -20
  348. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_existing_tsfn.cc +0 -125
  349. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_existing_tsfn.js +0 -14
  350. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ptr.cc +0 -27
  351. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ptr.js +0 -7
  352. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_sum.cc +0 -240
  353. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_sum.js +0 -59
  354. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_unref.cc +0 -55
  355. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_unref.js +0 -98
  356. package/vendor/node-addon-api/test/thunking_manual.cc +0 -127
  357. package/vendor/node-addon-api/test/thunking_manual.js +0 -16
  358. package/vendor/node-addon-api/test/type_taggable.cc +0 -66
  359. package/vendor/node-addon-api/test/type_taggable.js +0 -59
  360. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function.cc +0 -215
  361. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function.js +0 -188
  362. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ctx.cc +0 -120
  363. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ctx.js +0 -14
  364. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_exception.cc +0 -39
  365. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_exception.js +0 -13
  366. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_existing_tsfn.cc +0 -127
  367. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_existing_tsfn.js +0 -14
  368. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ptr.cc +0 -32
  369. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ptr.js +0 -8
  370. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_sum.cc +0 -237
  371. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_sum.js +0 -59
  372. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_unref.cc +0 -67
  373. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_unref.js +0 -98
  374. package/vendor/node-addon-api/test/typedarray-bigint.js +0 -58
  375. package/vendor/node-addon-api/test/typedarray.cc +0 -413
  376. package/vendor/node-addon-api/test/typedarray.js +0 -103
  377. package/vendor/node-addon-api/test/value_type_cast.cc +0 -60
  378. package/vendor/node-addon-api/test/value_type_cast.js +0 -106
  379. package/vendor/node-addon-api/test/version_management.cc +0 -28
  380. package/vendor/node-addon-api/test/version_management.js +0 -29
  381. package/vendor/node-addon-api/tools/README.md +0 -73
  382. package/vendor/node-addon-api/tools/check-napi.js +0 -99
  383. package/vendor/node-addon-api/tools/clang-format.js +0 -71
  384. package/vendor/node-addon-api/tools/conversion.js +0 -301
  385. package/vendor/node-addon-api/unit-test/README.md +0 -28
  386. package/vendor/node-addon-api/unit-test/binding-file-template.js +0 -39
  387. package/vendor/node-addon-api/unit-test/binding.gyp +0 -72
  388. package/vendor/node-addon-api/unit-test/exceptions.js +0 -32
  389. package/vendor/node-addon-api/unit-test/generate-binding-cc.js +0 -61
  390. package/vendor/node-addon-api/unit-test/injectTestParams.js +0 -101
  391. package/vendor/node-addon-api/unit-test/listOfTestModules.js +0 -88
  392. package/vendor/node-addon-api/unit-test/matchModules.js +0 -65
  393. package/vendor/node-addon-api/unit-test/setup.js +0 -13
  394. package/vendor/node-addon-api/unit-test/spawnTask.js +0 -26
  395. package/vendor/node-addon-api/unit-test/test.js +0 -30
  396. package/vendor/node-api-headers/CHANGELOG.md +0 -130
  397. package/vendor/node-api-headers/CODE_OF_CONDUCT.md +0 -4
  398. package/vendor/node-api-headers/CONTRIBUTING.md +0 -32
  399. package/vendor/node-api-headers/CREATING_A_RELEASE.md +0 -68
  400. package/vendor/node-api-headers/index.js +0 -17
  401. package/vendor/node-api-headers/lib/clang-utils.js +0 -50
  402. package/vendor/node-api-headers/lib/parse-utils.js +0 -92
  403. package/vendor/node-api-headers/package.json +0 -59
  404. package/vendor/node-api-headers/release-please-config.json +0 -12
  405. package/vendor/node-api-headers/scripts/update-headers.js +0 -246
  406. package/vendor/node-api-headers/scripts/write-symbols.js +0 -154
  407. package/vendor/node-api-headers/scripts/write-win32-def.js +0 -52
  408. package/vendor/node-api-headers/symbols.js +0 -257
  409. package/vendor/node-api-headers/test/parse-utils.js +0 -21
  410. /package/doc/{pages/benchmarks.md → benchmarks.md} +0 -0
  411. /package/doc/{pages/callbacks.md → callbacks.md} +0 -0
  412. /package/doc/{pages/contribute.md → contribute.md} +0 -0
  413. /package/doc/{pages/functions.md → functions.md} +0 -0
  414. /package/doc/{pages/index.md → index.md} +0 -0
  415. /package/doc/{pages/input.md → input.md} +0 -0
  416. /package/doc/{pages/migration.md → migration.md} +0 -0
  417. /package/doc/{pages/misc.md → misc.md} +0 -0
  418. /package/doc/{pages/output.md → output.md} +0 -0
  419. /package/doc/{pages/packaging.md → packaging.md} +0 -0
  420. /package/doc/{pages/platforms.md → platforms.md} +0 -0
  421. /package/doc/{pages/pointers.md → pointers.md} +0 -0
  422. /package/doc/{pages/start.md → start.md} +0 -0
  423. /package/doc/{pages/unions.md → unions.md} +0 -0
  424. /package/doc/{pages/variables.md → variables.md} +0 -0
  425. /package/src/koffi/src/{abi/loong64.cc → abi_loong64.cc} +0 -0
@@ -1,84 +0,0 @@
1
- #include "napi.h"
2
-
3
- static napi_value Getter_Core(napi_env env, napi_callback_info info) {
4
- (void)info;
5
- napi_value result;
6
- napi_status status = napi_create_uint32(env, 42, &result);
7
- NAPI_THROW_IF_FAILED(env, status, nullptr);
8
- return result;
9
- }
10
-
11
- static napi_value Setter_Core(napi_env env, napi_callback_info info) {
12
- size_t argc = 1;
13
- napi_value argv;
14
- napi_status status =
15
- napi_get_cb_info(env, info, &argc, &argv, nullptr, nullptr);
16
- NAPI_THROW_IF_FAILED(env, status, nullptr);
17
- (void)argv;
18
- return nullptr;
19
- }
20
-
21
- static Napi::Value Getter(const Napi::CallbackInfo& info) {
22
- return Napi::Number::New(info.Env(), 42);
23
- }
24
-
25
- static void Setter(const Napi::CallbackInfo& info) {
26
- (void)info[0];
27
- }
28
-
29
- #if NAPI_VERSION > 5
30
- class PropDescBenchmark : public Napi::Addon<PropDescBenchmark> {
31
- public:
32
- PropDescBenchmark(Napi::Env, Napi::Object exports) {
33
- DefineAddon(exports,
34
- {
35
- InstanceAccessor("addon",
36
- &PropDescBenchmark::Getter,
37
- &PropDescBenchmark::Setter,
38
- napi_enumerable),
39
- InstanceAccessor<&PropDescBenchmark::Getter,
40
- &PropDescBenchmark::Setter>(
41
- "addon_templated", napi_enumerable),
42
- });
43
- }
44
-
45
- private:
46
- Napi::Value Getter(const Napi::CallbackInfo& info) {
47
- return Napi::Number::New(info.Env(), 42);
48
- }
49
-
50
- void Setter(const Napi::CallbackInfo& info, const Napi::Value& val) {
51
- (void)info[0];
52
- (void)val;
53
- }
54
- };
55
- #endif // NAPI_VERSION > 5
56
-
57
- static Napi::Object Init(Napi::Env env, Napi::Object exports) {
58
- napi_status status;
59
- napi_property_descriptor core_prop = {"core",
60
- nullptr,
61
- nullptr,
62
- Getter_Core,
63
- Setter_Core,
64
- nullptr,
65
- napi_enumerable,
66
- nullptr};
67
-
68
- status = napi_define_properties(env, exports, 1, &core_prop);
69
- NAPI_THROW_IF_FAILED(env, status, Napi::Object());
70
-
71
- exports.DefineProperty(Napi::PropertyDescriptor::Accessor(
72
- env, exports, "cplusplus", Getter, Setter, napi_enumerable));
73
-
74
- exports.DefineProperty(Napi::PropertyDescriptor::Accessor<Getter, Setter>(
75
- "templated", napi_enumerable));
76
-
77
- #if NAPI_VERSION > 5
78
- PropDescBenchmark::Init(env, exports);
79
- #endif // NAPI_VERSION > 5
80
-
81
- return exports;
82
- }
83
-
84
- NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init)
@@ -1,38 +0,0 @@
1
- const path = require('path');
2
- const Benchmark = require('benchmark');
3
- const addonName = path.basename(__filename, '.js');
4
-
5
- [addonName, addonName + '_noexcept']
6
- .forEach((addonName) => {
7
- const rootAddon = require('bindings')({
8
- bindings: addonName,
9
- module_root: __dirname
10
- });
11
- delete rootAddon.path;
12
- const getters = new Benchmark.Suite();
13
- const setters = new Benchmark.Suite();
14
- const maxNameLength = Object.keys(rootAddon)
15
- .reduce((soFar, value) => Math.max(soFar, value.length), 0);
16
-
17
- console.log(`\n${addonName}: `);
18
-
19
- Object.keys(rootAddon).forEach((key) => {
20
- getters.add(`${key} getter`.padStart(maxNameLength + 7), () => {
21
- // eslint-disable-next-line no-unused-vars
22
- const x = rootAddon[key];
23
- });
24
- setters.add(`${key} setter`.padStart(maxNameLength + 7), () => {
25
- rootAddon[key] = 5;
26
- });
27
- });
28
-
29
- getters
30
- .on('cycle', (event) => console.log(String(event.target)))
31
- .run();
32
-
33
- console.log('');
34
-
35
- setters
36
- .on('cycle', (event) => console.log(String(event.target)))
37
- .run();
38
- });
@@ -1,21 +0,0 @@
1
- {
2
- 'variables': {
3
- 'NAPI_VERSION%': "<!(node -p \"process.env.NAPI_VERSION || process.versions.napi\")",
4
- 'disable_deprecated': "<!(node -p \"process.env['npm_config_disable_deprecated']\")"
5
- },
6
- 'conditions': [
7
- ['NAPI_VERSION!=""', { 'defines': ['NAPI_VERSION=<@(NAPI_VERSION)'] } ],
8
- ['NAPI_VERSION==2147483647', { 'defines': ['NAPI_EXPERIMENTAL'] } ],
9
- ['disable_deprecated=="true"', {
10
- 'defines': ['NODE_ADDON_API_DISABLE_DEPRECATED']
11
- }],
12
- ['OS=="mac"', {
13
- 'cflags+': ['-fvisibility=hidden'],
14
- 'xcode_settings': {
15
- 'OTHER_CFLAGS': ['-fvisibility=hidden']
16
- }
17
- }]
18
- ],
19
- 'cflags': [ '-Werror', '-Wall', '-Wextra', '-Wpedantic', '-Wunused-parameter' ],
20
- 'cflags_cc': [ '-Werror', '-Wall', '-Wextra', '-Wpedantic', '-Wunused-parameter' ]
21
- }
@@ -1,145 +0,0 @@
1
- # node-addon-api Documents
2
-
3
- * [Setup](#setup)
4
- * [API Documentation](#api)
5
- * [Examples](#examples)
6
- * [ABI Stability Guideline](#abi-stability-guideline)
7
- * [More resource and info about native Addons](#resources)
8
-
9
- Node-API is an ABI stable C interface provided by Node.js for building native
10
- addons. It is independent of the underlying JavaScript runtime (e.g. V8 or ChakraCore)
11
- and is maintained as part of Node.js itself. It is intended to insulate
12
- native addons from changes in the underlying JavaScript engine and allow
13
- modules compiled for one version to run on later versions of Node.js without
14
- recompilation.
15
-
16
- The `node-addon-api` module, which is not part of Node.js, preserves the benefits
17
- of the Node-API as it consists only of inline code that depends only on the stable API
18
- provided by Node-API. As such, modules built against one version of Node.js
19
- using node-addon-api should run without having to be rebuilt with newer versions
20
- of Node.js.
21
-
22
- ## Setup
23
- - [Installation and usage](setup.md)
24
- - [node-gyp](node-gyp.md)
25
- - [cmake-js](cmake-js.md)
26
- - [Conversion tool](conversion-tool.md)
27
- - [Checker tool](checker-tool.md)
28
- - [Generator](generator.md)
29
- - [Prebuild tools](prebuild_tools.md)
30
-
31
- <a name="api"></a>
32
-
33
- ## API Documentation
34
-
35
- The following is the documentation for node-addon-api.
36
-
37
- - [Full Class Hierarchy](hierarchy.md)
38
- - [Addon Structure](addon.md)
39
- - Data Types:
40
- - [BasicEnv](basic_env.md)
41
- - [Env](env.md)
42
- - [CallbackInfo](callbackinfo.md)
43
- - [Reference](reference.md)
44
- - [Value](value.md)
45
- - [Name](name.md)
46
- - [Symbol](symbol.md)
47
- - [String](string.md)
48
- - [Number](number.md)
49
- - [Date](date.md)
50
- - [BigInt](bigint.md)
51
- - [Boolean](boolean.md)
52
- - [External](external.md)
53
- - [Object](object.md)
54
- - [Array](array.md)
55
- - [ObjectReference](object_reference.md)
56
- - [PropertyDescriptor](property_descriptor.md)
57
- - [Function](function.md)
58
- - [FunctionReference](function_reference.md)
59
- - [ObjectWrap](object_wrap.md)
60
- - [ClassPropertyDescriptor](class_property_descriptor.md)
61
- - [Buffer](buffer.md)
62
- - [ArrayBuffer](array_buffer.md)
63
- - [TypedArray](typed_array.md)
64
- - [TypedArrayOf](typed_array_of.md)
65
- - [DataView](dataview.md)
66
- - [Error Handling](error_handling.md)
67
- - [Error](error.md)
68
- - [TypeError](type_error.md)
69
- - [RangeError](range_error.md)
70
- - [SyntaxError](syntax_error.md)
71
- - [Object Lifetime Management](object_lifetime_management.md)
72
- - [HandleScope](handle_scope.md)
73
- - [EscapableHandleScope](escapable_handle_scope.md)
74
- - [Finalization](finalization.md)
75
- - [Memory Management](memory_management.md)
76
- - [Async Operations](async_operations.md)
77
- - [AsyncWorker](async_worker.md)
78
- - [AsyncContext](async_context.md)
79
- - [AsyncWorker Variants](async_worker_variants.md)
80
- - [Thread-safe Functions](threadsafe.md)
81
- - [ThreadSafeFunction](threadsafe_function.md)
82
- - [TypedThreadSafeFunction](typed_threadsafe_function.md)
83
- - [Promises](promises.md)
84
- - [Version management](version_management.md)
85
-
86
- <a name="examples"></a>
87
-
88
- ## Examples
89
-
90
- Are you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**
91
-
92
- - [Hello World](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/1_hello_world)
93
- - [Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/2_function_arguments/node-addon-api)
94
- - [Callbacks](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/3_callbacks/node-addon-api)
95
- - [Object factory](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/4_object_factory/node-addon-api)
96
- - [Function factory](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/5_function_factory/node-addon-api)
97
- - [Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/6_object_wrap/node-addon-api)
98
- - [Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/main/src/1-getting-started/7_factory_wrap/node-addon-api)
99
- - [Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/main/src/2-js-to-native-conversion/8_passing_wrapped/node-addon-api)
100
-
101
- <a name="abi-stability-guideline"></a>
102
-
103
- ## ABI Stability Guideline
104
-
105
- It is important to remember that *other* Node.js interfaces such as
106
- `libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
107
- Node.js major versions. Thus, an addon must use Node-API and/or `node-addon-api`
108
- exclusively and build against a version of Node.js that includes an
109
- implementation of Node-API (meaning an active LTS version of Node.js) in
110
- order to benefit from ABI stability across Node.js major versions. Node.js
111
- provides an [ABI stability guide][] containing a detailed explanation of ABI
112
- stability in general, and the Node-API ABI stability guarantee in particular.
113
-
114
- <a name="resources"></a>
115
-
116
- ## More resource and info about native Addons
117
-
118
- There are three options for implementing addons: Node-API, nan, or direct
119
- use of internal V8, libuv, and Node.js libraries. Unless there is a need for
120
- direct access to functionality that is not exposed by Node-API as outlined
121
- in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)
122
- in Node.js core, use Node-API. Refer to
123
- [C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
124
- for more information on Node-API.
125
-
126
- - [C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)
127
- - [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
128
- - [Node-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)
129
- - [How We Migrated Realm JavaScript From NAN to Node-API](https://developer.mongodb.com/article/realm-javascript-nan-to-n-api)
130
-
131
- As node-addon-api's core mission is to expose the plain C Node-API as C++
132
- wrappers, tools that facilitate n-api/node-addon-api providing more
133
- convenient patterns for developing a Node.js add-on with n-api/node-addon-api
134
- can be published to NPM as standalone packages. It is also recommended to tag
135
- such packages with `node-addon-api` to provide more visibility to the community.
136
-
137
- Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).
138
-
139
- <a name="other-bindings"></a>
140
-
141
- ## Other bindings
142
-
143
- - [napi-rs](https://napi.rs) - (`Rust`)
144
-
145
- [ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/
@@ -1,163 +0,0 @@
1
- # Add-on Structure
2
-
3
- Class `Napi::Addon<T>` inherits from class [`Napi::InstanceWrap<T>`][].
4
-
5
- Creating add-ons that work correctly when loaded multiple times from the same
6
- source package into multiple Node.js threads and/or multiple times into the same
7
- Node.js thread requires that all global data they hold be associated with the
8
- environment in which they run. It is not safe to store global data in static
9
- variables because doing so does not take into account the fact that an add-on
10
- may be loaded into multiple threads nor that an add-on may be loaded multiple
11
- times into a single thread.
12
-
13
- The `Napi::Addon<T>` class can be used to define an entire add-on. Instances of
14
- `Napi::Addon<T>` subclasses become instances of the add-on, stored safely by
15
- Node.js on its various threads and into its various contexts. Thus, any data
16
- stored in the instance variables of a `Napi::Addon<T>` subclass instance are
17
- stored safely by Node.js. Functions exposed to JavaScript using
18
- `Napi::Addon<T>::InstanceMethod` and/or `Napi::Addon<T>::DefineAddon` are
19
- instance methods of the `Napi::Addon` subclass and thus have access to data
20
- stored inside the instance.
21
-
22
- `Napi::Addon<T>::DefineProperties` may be used to attach `Napi::Addon<T>`
23
- subclass instance methods to objects other than the one that will be returned to
24
- Node.js as the add-on instance.
25
-
26
- The `Napi::Addon<T>` class can be used together with the `NODE_API_ADDON()` and
27
- `NODE_API_NAMED_ADDON()` macros to define add-ons.
28
-
29
- ## Example
30
-
31
- ```cpp
32
- #include <napi.h>
33
-
34
- class ExampleAddon : public Napi::Addon<ExampleAddon> {
35
- public:
36
- ExampleAddon(Napi::Env env, Napi::Object exports) {
37
- // In the constructor we declare the functions the add-on makes available
38
- // to JavaScript.
39
- DefineAddon(exports, {
40
- InstanceMethod("increment", &ExampleAddon::Increment),
41
-
42
- // We can also attach plain objects to `exports`, and instance methods as
43
- // properties of those sub-objects.
44
- InstanceValue("subObject", DefineProperties(Napi::Object::New(env), {
45
- InstanceMethod("decrement", &ExampleAddon::Decrement)
46
- }), napi_enumerable)
47
- });
48
- }
49
- private:
50
-
51
- // This method has access to the data stored in the environment because it is
52
- // an instance method of `ExampleAddon` and because it was listed among the
53
- // property descriptors passed to `DefineAddon()` in the constructor.
54
- Napi::Value Increment(const Napi::CallbackInfo& info) {
55
- return Napi::Number::New(info.Env(), ++value);
56
- }
57
-
58
- // This method has access to the data stored in the environment because it is
59
- // an instance method of `ExampleAddon` and because it was exposed to
60
- // JavaScript by calling `DefineProperties()` with the object onto which it is
61
- // attached.
62
- Napi::Value Decrement(const Napi::CallbackInfo& info) {
63
- return Napi::Number::New(info.Env(), --value);
64
- }
65
-
66
- // Data stored in these variables is unique to each instance of the add-on.
67
- uint32_t value = 42;
68
- };
69
-
70
- // The macro announces that instances of the class `ExampleAddon` will be
71
- // created for each instance of the add-on that must be loaded into Node.js.
72
- NODE_API_ADDON(ExampleAddon)
73
- ```
74
-
75
- The above code can be used from JavaScript as follows:
76
-
77
- ```js
78
- 'use strict'
79
-
80
- const exampleAddon = require('bindings')('example_addon');
81
- console.log(exampleAddon.increment()); // prints 43
82
- console.log(exampleAddon.increment()); // prints 44
83
- console.log(exampleAddon.subObject.decrement()); // prints 43
84
- ```
85
-
86
- When Node.js loads an instance of the add-on, a new instance of the class is
87
- created. Its constructor receives the environment `Napi::Env env` and the
88
- exports object `Napi::Object exports`. It can then use the method `DefineAddon`
89
- to either attach methods, accessors, and/or values to the `exports` object or to
90
- create its own `exports` object and attach methods, accessors, and/or values to
91
- it.
92
-
93
- **Note:** `Napi::Addon<T>` uses `Napi::Env::SetInstanceData()` internally. This
94
- means that the add-on should only use `Napi::Env::GetInstanceData` explicitly to
95
- retrieve the instance of the `Napi::Addon<T>` class. Variables whose scope would
96
- otherwise be global should be stored as instance variables in the
97
- `Napi::Addon<T>` class.
98
-
99
- Functions created with `Napi::Function::New()`, accessors created with
100
- `PropertyDescriptor::Accessor()`, and values can also be attached. If their
101
- implementation requires the `ExampleAddon` instance, it can be retrieved from
102
- the `Napi::Env env` with `GetInstanceData()`:
103
-
104
- ```cpp
105
- void ExampleBinding(const Napi::CallbackInfo& info) {
106
- ExampleAddon* addon = info.Env().GetInstanceData<ExampleAddon>();
107
- }
108
- ```
109
-
110
- ## Methods
111
-
112
- ### Constructor
113
-
114
- Creates a new instance of the add-on.
115
-
116
- ```cpp
117
- Napi::Addon(Napi::Env env, Napi::Object exports);
118
- ```
119
-
120
- - `[in] env`: The environment into which the add-on is being loaded.
121
- - `[in] exports`: The exports object received from JavaScript.
122
-
123
- Typically, the constructor calls `DefineAddon()` to attach methods, accessors,
124
- and/or values to `exports`. The constructor may also create a new object and
125
- pass it to `DefineAddon()` as its first parameter if it wishes to replace the
126
- `exports` object as provided by Node.js.
127
-
128
- ### DefineAddon
129
-
130
- Defines an add-on instance with functions, accessors, and/or values.
131
-
132
- ```cpp
133
- template <typename T>
134
- void Napi::Addon<T>::DefineAddon(Napi::Object exports,
135
- const std::initializer_list<PropertyDescriptor>& properties);
136
- ```
137
-
138
- * `[in] exports`: The object to return to Node.js as an instance of the add-on.
139
- * `[in] properties`: Initializer list of add-on property descriptors of the
140
- methods, property accessors, and values that define the add-on. They will be
141
- set on `exports`.
142
- See: [`Class property and descriptor`](class_property_descriptor.md).
143
-
144
- ### DefineProperties
145
-
146
- Defines function, accessor, and/or value properties on an object using add-on
147
- instance methods.
148
-
149
- ```cpp
150
- template <typename T>
151
- Napi::Object
152
- Napi::Addon<T>::DefineProperties(Napi::Object object,
153
- const std::initializer_list<PropertyDescriptor>& properties);
154
- ```
155
-
156
- * `[in] object`: The object that will receive the new properties.
157
- * `[in] properties`: Initializer list of property descriptors of the methods,
158
- property accessors, and values to attach to `object`.
159
- See: [`Class property and descriptor`](class_property_descriptor.md).
160
-
161
- Returns `object`.
162
-
163
- [`Napi::InstanceWrap<T>`]: ./instance_wrap.md
@@ -1,81 +0,0 @@
1
- # Array
2
-
3
- Class [`Napi::Array`][] inherits from class [`Napi::Object`][].
4
-
5
- Arrays are native representations of JavaScript Arrays. `Napi::Array` is a wrapper
6
- around `napi_value` representing a JavaScript Array.
7
-
8
- [`Napi::TypedArray`][] and [`Napi::ArrayBuffer`][] correspond to JavaScript data
9
- types such as [`Napi::Int32Array`][] and [`Napi::ArrayBuffer`][], respectively,
10
- that can be used for transferring large amounts of data from JavaScript to the
11
- native side. An example illustrating the use of a JavaScript-provided
12
- `ArrayBuffer` in native code is available [here](https://github.com/nodejs/node-addon-examples/tree/main/src/2-js-to-native-conversion/array_buffer_to_native/node-addon-api).
13
-
14
- ## Constructor
15
- ```cpp
16
- Napi::Array::Array();
17
- ```
18
-
19
- Returns an empty array.
20
-
21
- If an error occurs, a `Napi::Error` will be thrown. If C++ exceptions are not
22
- being used, callers should check the result of `Env::IsExceptionPending` before
23
- attempting to use the returned value.
24
-
25
- ```cpp
26
- Napi::Array::Array(napi_env env, napi_value value);
27
- ```
28
- - `[in] env` - The environment in which to create the array.
29
- - `[in] value` - The primitive to wrap.
30
-
31
- Returns a `Napi::Array` wrapping a `napi_value`.
32
-
33
- If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not
34
- being used, callers should check the result of `Env::IsExceptionPending` before
35
- attempting to use the returned value.
36
-
37
- ## Methods
38
-
39
- ### New
40
- ```cpp
41
- static Napi::Array Napi::Array::New(napi_env env);
42
- ```
43
- - `[in] env` - The environment in which to create the array.
44
-
45
- Returns a new `Napi::Array`.
46
-
47
- If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not
48
- being used, callers should check the result of `Env::IsExceptionPending` before
49
- attempting to use the returned value.
50
-
51
- ### New
52
-
53
- ```cpp
54
- static Napi::Array Napi::Array::New(napi_env env, size_t length);
55
- ```
56
- - `[in] env` - The environment in which to create the array.
57
- - `[in] length` - The length of the array.
58
-
59
- Returns a new `Napi::Array` with the given length.
60
-
61
- If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not
62
- being used, callers should check the result of `Env::IsExceptionPending` before
63
- attempting to use the returned value.
64
-
65
- ### Length
66
- ```cpp
67
- uint32_t Napi::Array::Length() const;
68
- ```
69
-
70
- Returns the length of the array.
71
-
72
- Note:
73
- This can execute JavaScript code implicitly according to JavaScript semantics.
74
- If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not
75
- being used, callers should check the result of `Env::IsExceptionPending` before
76
- attempting to use the returned value.
77
-
78
- [`Napi::ArrayBuffer`]: ./array_buffer.md
79
- [`Napi::Int32Array`]: ./typed_array_of.md
80
- [`Napi::Object`]: ./object.md
81
- [`Napi::TypedArray`]: ./typed_array.md