koffi 0.9.3 → 0.9.6

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 (330) hide show
  1. package/CMakeLists.txt +63 -60
  2. package/README.md +162 -153
  3. package/package.json +19 -18
  4. package/src/call.hh +27 -27
  5. package/src/call_arm32.cc +514 -0
  6. package/src/call_arm32_fwd.S +108 -0
  7. package/src/call_arm64.cc +497 -482
  8. package/src/call_arm64_fwd.S +110 -115
  9. package/src/call_x64_sysv.cc +477 -477
  10. package/src/call_x64_sysv_fwd.S +131 -131
  11. package/src/call_x64_win.cc +243 -243
  12. package/src/call_x64_win_fwd.asm +105 -105
  13. package/src/call_x86.cc +259 -259
  14. package/src/call_x86_fwd.S +48 -48
  15. package/src/call_x86_fwd.asm +50 -50
  16. package/src/ffi.cc +504 -504
  17. package/src/ffi.hh +136 -135
  18. package/src/util.cc +297 -296
  19. package/src/util.hh +80 -80
  20. package/vendor/dragonbox/CMakeLists.txt +122 -122
  21. package/vendor/dragonbox/LICENSE-Apache2-LLVM +218 -218
  22. package/vendor/dragonbox/LICENSE-Boost +23 -23
  23. package/vendor/dragonbox/README.md +277 -277
  24. package/vendor/dragonbox/cmake/dragonboxConfig.cmake +1 -1
  25. package/vendor/dragonbox/include/dragonbox/dragonbox.h +2674 -2670
  26. package/vendor/dragonbox/include/dragonbox/dragonbox_to_chars.h +108 -108
  27. package/vendor/dragonbox/other_files/Dragonbox.pdf +0 -0
  28. package/vendor/dragonbox/other_files/unknown_win64_vc2019.html +539 -539
  29. package/vendor/dragonbox/source/dragonbox_to_chars.cpp +303 -303
  30. package/vendor/dragonbox/subproject/3rdparty/grisu_exact/CMakeLists.txt +23 -23
  31. package/vendor/dragonbox/subproject/3rdparty/grisu_exact/fp_to_chars.cpp +238 -238
  32. package/vendor/dragonbox/subproject/3rdparty/grisu_exact/fp_to_chars.h +95 -95
  33. package/vendor/dragonbox/subproject/3rdparty/grisu_exact/grisu_exact.h +2666 -2666
  34. package/vendor/dragonbox/subproject/3rdparty/ryu/CMakeLists.txt +16 -16
  35. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/common.h +114 -114
  36. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/d2s.c +509 -509
  37. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/d2s_full_table.h +367 -367
  38. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/d2s_intrinsics.h +357 -357
  39. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/digit_table.h +35 -35
  40. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/f2s.c +345 -345
  41. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/f2s_full_table.h +55 -55
  42. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/f2s_intrinsics.h +128 -128
  43. package/vendor/dragonbox/subproject/3rdparty/ryu/ryu/ryu.h +46 -46
  44. package/vendor/dragonbox/subproject/3rdparty/schubfach/CMakeLists.txt +21 -21
  45. package/vendor/dragonbox/subproject/3rdparty/schubfach/schubfach_32.cc +699 -699
  46. package/vendor/dragonbox/subproject/3rdparty/schubfach/schubfach_32.h +31 -31
  47. package/vendor/dragonbox/subproject/3rdparty/schubfach/schubfach_64.cc +1354 -1354
  48. package/vendor/dragonbox/subproject/3rdparty/schubfach/schubfach_64.h +31 -31
  49. package/vendor/dragonbox/subproject/3rdparty/shaded_plots/example_shaded_plots.m +68 -68
  50. package/vendor/dragonbox/subproject/3rdparty/shaded_plots/license.txt +25 -25
  51. package/vendor/dragonbox/subproject/3rdparty/shaded_plots/plot_distribution.m +92 -92
  52. package/vendor/dragonbox/subproject/3rdparty/shaded_plots/plot_distribution_prctile.m +121 -121
  53. package/vendor/dragonbox/subproject/3rdparty/shaded_plots/plot_histogram_shaded.m +99 -99
  54. package/vendor/dragonbox/subproject/3rdparty/shaded_plots/plot_shaded.m +93 -93
  55. package/vendor/dragonbox/subproject/benchmark/CMakeLists.txt +64 -64
  56. package/vendor/dragonbox/subproject/benchmark/include/benchmark.h +40 -40
  57. package/vendor/dragonbox/subproject/benchmark/matlab/plot_benchmarks.m +21 -21
  58. package/vendor/dragonbox/subproject/benchmark/matlab/plot_digit_benchmark.m +78 -78
  59. package/vendor/dragonbox/subproject/benchmark/matlab/plot_uniform_benchmark.m +95 -95
  60. package/vendor/dragonbox/subproject/benchmark/source/benchmark.cpp +237 -237
  61. package/vendor/dragonbox/subproject/benchmark/source/dragonbox.cpp +30 -30
  62. package/vendor/dragonbox/subproject/benchmark/source/grisu_exact.cpp +36 -36
  63. package/vendor/dragonbox/subproject/benchmark/source/ryu.cpp +27 -27
  64. package/vendor/dragonbox/subproject/benchmark/source/schubfach.cpp +31 -31
  65. package/vendor/dragonbox/subproject/common/CMakeLists.txt +41 -41
  66. package/vendor/dragonbox/subproject/common/include/best_rational_approx.h +96 -96
  67. package/vendor/dragonbox/subproject/common/include/big_uint.h +217 -217
  68. package/vendor/dragonbox/subproject/common/include/continued_fractions.h +173 -173
  69. package/vendor/dragonbox/subproject/common/include/good_rational_approx.h +266 -266
  70. package/vendor/dragonbox/subproject/common/include/random_float.h +182 -182
  71. package/vendor/dragonbox/subproject/common/include/rational_continued_fractions.h +56 -56
  72. package/vendor/dragonbox/subproject/common/source/big_uint.cpp +601 -601
  73. package/vendor/dragonbox/subproject/meta/CMakeLists.txt +40 -40
  74. package/vendor/dragonbox/subproject/meta/results/binary32_generated_cache.txt +81 -81
  75. package/vendor/dragonbox/subproject/meta/results/binary64_compressed_cache_error_table.txt +9 -9
  76. package/vendor/dragonbox/subproject/meta/results/binary64_generated_cache.txt +622 -622
  77. package/vendor/dragonbox/subproject/meta/source/generate_cache.cpp +126 -126
  78. package/vendor/dragonbox/subproject/meta/source/live_test.cpp +81 -81
  79. package/vendor/dragonbox/subproject/meta/source/perf_test.cpp +104 -104
  80. package/vendor/dragonbox/subproject/meta/source/sandbox.cpp +20 -20
  81. package/vendor/dragonbox/subproject/test/CMakeLists.txt +69 -69
  82. package/vendor/dragonbox/subproject/test/results/binary32.csv +255 -255
  83. package/vendor/dragonbox/subproject/test/results/binary64.csv +2047 -2047
  84. package/vendor/dragonbox/subproject/test/results/plot_required_bits.m +17 -17
  85. package/vendor/dragonbox/subproject/test/source/test_all_shorter_interval_cases.cpp +88 -88
  86. package/vendor/dragonbox/subproject/test/source/uniform_random_test.cpp +95 -95
  87. package/vendor/dragonbox/subproject/test/source/verify_cache_precision.cpp +337 -337
  88. package/vendor/dragonbox/subproject/test/source/verify_compressed_cache.cpp +154 -154
  89. package/vendor/dragonbox/subproject/test/source/verify_fast_multiplication.cpp +168 -168
  90. package/vendor/dragonbox/subproject/test/source/verify_log_computation.cpp +251 -251
  91. package/vendor/dragonbox/subproject/test/source/verify_magic_division.cpp +113 -113
  92. package/vendor/libcc/libcc.cc +7651 -7651
  93. package/vendor/libcc/libcc.hh +4312 -4312
  94. package/vendor/node-addon-api/CHANGELOG.md +859 -859
  95. package/vendor/node-addon-api/CODE_OF_CONDUCT.md +4 -4
  96. package/vendor/node-addon-api/CONTRIBUTING.md +93 -93
  97. package/vendor/node-addon-api/LICENSE.md +12 -12
  98. package/vendor/node-addon-api/README.md +293 -293
  99. package/vendor/node-addon-api/appveyor.yml +37 -37
  100. package/vendor/node-addon-api/benchmark/README.md +47 -47
  101. package/vendor/node-addon-api/benchmark/binding.gyp +25 -25
  102. package/vendor/node-addon-api/benchmark/function_args.cc +217 -217
  103. package/vendor/node-addon-api/benchmark/function_args.js +60 -60
  104. package/vendor/node-addon-api/benchmark/index.js +34 -34
  105. package/vendor/node-addon-api/benchmark/property_descriptor.cc +91 -91
  106. package/vendor/node-addon-api/benchmark/property_descriptor.js +37 -37
  107. package/vendor/node-addon-api/common.gypi +21 -21
  108. package/vendor/node-addon-api/doc/addon.md +163 -163
  109. package/vendor/node-addon-api/doc/array.md +81 -81
  110. package/vendor/node-addon-api/doc/array_buffer.md +155 -155
  111. package/vendor/node-addon-api/doc/async_context.md +86 -86
  112. package/vendor/node-addon-api/doc/async_operations.md +31 -31
  113. package/vendor/node-addon-api/doc/async_worker.md +427 -427
  114. package/vendor/node-addon-api/doc/async_worker_variants.md +557 -557
  115. package/vendor/node-addon-api/doc/bigint.md +97 -97
  116. package/vendor/node-addon-api/doc/boolean.md +68 -68
  117. package/vendor/node-addon-api/doc/buffer.md +150 -150
  118. package/vendor/node-addon-api/doc/callback_scope.md +54 -54
  119. package/vendor/node-addon-api/doc/callbackinfo.md +97 -97
  120. package/vendor/node-addon-api/doc/checker-tool.md +32 -32
  121. package/vendor/node-addon-api/doc/class_property_descriptor.md +115 -115
  122. package/vendor/node-addon-api/doc/cmake-js.md +68 -68
  123. package/vendor/node-addon-api/doc/conversion-tool.md +27 -27
  124. package/vendor/node-addon-api/doc/creating_a_release.md +62 -62
  125. package/vendor/node-addon-api/doc/dataview.md +248 -248
  126. package/vendor/node-addon-api/doc/date.md +68 -68
  127. package/vendor/node-addon-api/doc/env.md +196 -196
  128. package/vendor/node-addon-api/doc/error.md +120 -120
  129. package/vendor/node-addon-api/doc/error_handling.md +254 -254
  130. package/vendor/node-addon-api/doc/escapable_handle_scope.md +80 -80
  131. package/vendor/node-addon-api/doc/external.md +63 -63
  132. package/vendor/node-addon-api/doc/function.md +402 -402
  133. package/vendor/node-addon-api/doc/function_reference.md +238 -238
  134. package/vendor/node-addon-api/doc/generator.md +13 -13
  135. package/vendor/node-addon-api/doc/handle_scope.md +63 -63
  136. package/vendor/node-addon-api/doc/hierarchy.md +91 -91
  137. package/vendor/node-addon-api/doc/instance_wrap.md +408 -408
  138. package/vendor/node-addon-api/doc/maybe.md +76 -76
  139. package/vendor/node-addon-api/doc/memory_management.md +27 -27
  140. package/vendor/node-addon-api/doc/name.md +29 -29
  141. package/vendor/node-addon-api/doc/node-gyp.md +82 -82
  142. package/vendor/node-addon-api/doc/number.md +163 -163
  143. package/vendor/node-addon-api/doc/object.md +432 -432
  144. package/vendor/node-addon-api/doc/object_lifetime_management.md +83 -83
  145. package/vendor/node-addon-api/doc/object_reference.md +117 -117
  146. package/vendor/node-addon-api/doc/object_wrap.md +561 -561
  147. package/vendor/node-addon-api/doc/prebuild_tools.md +16 -16
  148. package/vendor/node-addon-api/doc/promises.md +79 -79
  149. package/vendor/node-addon-api/doc/property_descriptor.md +286 -286
  150. package/vendor/node-addon-api/doc/propertylvalue.md +50 -50
  151. package/vendor/node-addon-api/doc/range_error.md +59 -59
  152. package/vendor/node-addon-api/doc/reference.md +113 -113
  153. package/vendor/node-addon-api/doc/setup.md +110 -110
  154. package/vendor/node-addon-api/doc/string.md +93 -93
  155. package/vendor/node-addon-api/doc/symbol.md +60 -60
  156. package/vendor/node-addon-api/doc/threadsafe.md +121 -121
  157. package/vendor/node-addon-api/doc/threadsafe_function.md +290 -290
  158. package/vendor/node-addon-api/doc/type_error.md +59 -59
  159. package/vendor/node-addon-api/doc/typed_array.md +78 -78
  160. package/vendor/node-addon-api/doc/typed_array_of.md +137 -137
  161. package/vendor/node-addon-api/doc/typed_threadsafe_function.md +306 -306
  162. package/vendor/node-addon-api/doc/value.md +340 -340
  163. package/vendor/node-addon-api/doc/version_management.md +43 -43
  164. package/vendor/node-addon-api/except.gypi +25 -25
  165. package/vendor/node-addon-api/index.js +11 -11
  166. package/vendor/node-addon-api/napi-inl.deprecated.h +192 -192
  167. package/vendor/node-addon-api/napi-inl.h +6209 -6209
  168. package/vendor/node-addon-api/napi.h +2983 -2983
  169. package/vendor/node-addon-api/node_api.gyp +9 -9
  170. package/vendor/node-addon-api/noexcept.gypi +26 -26
  171. package/vendor/node-addon-api/package-support.json +21 -21
  172. package/vendor/node-addon-api/package.json +399 -399
  173. package/vendor/node-addon-api/test/README.md +91 -91
  174. package/vendor/node-addon-api/test/addon.cc +36 -36
  175. package/vendor/node-addon-api/test/addon.js +11 -11
  176. package/vendor/node-addon-api/test/addon_build/index.js +49 -49
  177. package/vendor/node-addon-api/test/addon_build/tpl/addon.cc +17 -17
  178. package/vendor/node-addon-api/test/addon_build/tpl/binding.gyp +62 -62
  179. package/vendor/node-addon-api/test/addon_build/tpl/index.js +9 -9
  180. package/vendor/node-addon-api/test/addon_build/tpl/package.json +11 -11
  181. package/vendor/node-addon-api/test/addon_data.cc +99 -99
  182. package/vendor/node-addon-api/test/addon_data.js +46 -46
  183. package/vendor/node-addon-api/test/array_buffer.cc +243 -243
  184. package/vendor/node-addon-api/test/array_buffer.js +69 -69
  185. package/vendor/node-addon-api/test/async_context.cc +21 -21
  186. package/vendor/node-addon-api/test/async_context.js +86 -86
  187. package/vendor/node-addon-api/test/async_progress_queue_worker.cc +83 -83
  188. package/vendor/node-addon-api/test/async_progress_queue_worker.js +46 -46
  189. package/vendor/node-addon-api/test/async_progress_worker.cc +134 -134
  190. package/vendor/node-addon-api/test/async_progress_worker.js +61 -61
  191. package/vendor/node-addon-api/test/async_worker.cc +106 -106
  192. package/vendor/node-addon-api/test/async_worker.js +179 -179
  193. package/vendor/node-addon-api/test/async_worker_nocallback.js +13 -13
  194. package/vendor/node-addon-api/test/async_worker_persistent.cc +63 -63
  195. package/vendor/node-addon-api/test/async_worker_persistent.js +24 -24
  196. package/vendor/node-addon-api/test/basic_types/array.cc +40 -40
  197. package/vendor/node-addon-api/test/basic_types/array.js +35 -35
  198. package/vendor/node-addon-api/test/basic_types/boolean.cc +38 -38
  199. package/vendor/node-addon-api/test/basic_types/boolean.js +35 -35
  200. package/vendor/node-addon-api/test/basic_types/number.cc +99 -99
  201. package/vendor/node-addon-api/test/basic_types/number.js +114 -114
  202. package/vendor/node-addon-api/test/basic_types/value.cc +120 -120
  203. package/vendor/node-addon-api/test/basic_types/value.js +133 -133
  204. package/vendor/node-addon-api/test/bigint.cc +91 -91
  205. package/vendor/node-addon-api/test/bigint.js +53 -53
  206. package/vendor/node-addon-api/test/binding-swallowexcept.cc +12 -12
  207. package/vendor/node-addon-api/test/binding.cc +171 -171
  208. package/vendor/node-addon-api/test/binding.gyp +117 -117
  209. package/vendor/node-addon-api/test/buffer.cc +183 -183
  210. package/vendor/node-addon-api/test/buffer.js +69 -69
  211. package/vendor/node-addon-api/test/callbackscope.cc +22 -22
  212. package/vendor/node-addon-api/test/callbackscope.js +49 -49
  213. package/vendor/node-addon-api/test/common/index.js +113 -113
  214. package/vendor/node-addon-api/test/common/test_helper.h +61 -61
  215. package/vendor/node-addon-api/test/dataview/dataview.cc +48 -48
  216. package/vendor/node-addon-api/test/dataview/dataview.js +35 -35
  217. package/vendor/node-addon-api/test/dataview/dataview_read_write.cc +115 -115
  218. package/vendor/node-addon-api/test/dataview/dataview_read_write.js +90 -90
  219. package/vendor/node-addon-api/test/date.cc +44 -44
  220. package/vendor/node-addon-api/test/date.js +18 -18
  221. package/vendor/node-addon-api/test/env_cleanup.cc +88 -88
  222. package/vendor/node-addon-api/test/env_cleanup.js +56 -56
  223. package/vendor/node-addon-api/test/error.cc +287 -287
  224. package/vendor/node-addon-api/test/error.js +81 -81
  225. package/vendor/node-addon-api/test/error_handling_for_primitives.cc +13 -13
  226. package/vendor/node-addon-api/test/error_handling_for_primitives.js +29 -29
  227. package/vendor/node-addon-api/test/error_terminating_environment.js +94 -94
  228. package/vendor/node-addon-api/test/external.cc +81 -81
  229. package/vendor/node-addon-api/test/external.js +88 -88
  230. package/vendor/node-addon-api/test/function.cc +295 -295
  231. package/vendor/node-addon-api/test/function.js +121 -121
  232. package/vendor/node-addon-api/test/function_reference.cc +202 -202
  233. package/vendor/node-addon-api/test/function_reference.js +157 -157
  234. package/vendor/node-addon-api/test/globalObject/global_object.cc +61 -61
  235. package/vendor/node-addon-api/test/globalObject/global_object_delete_property.cc +31 -31
  236. package/vendor/node-addon-api/test/globalObject/global_object_delete_property.js +61 -61
  237. package/vendor/node-addon-api/test/globalObject/global_object_get_property.cc +40 -40
  238. package/vendor/node-addon-api/test/globalObject/global_object_get_property.js +57 -57
  239. package/vendor/node-addon-api/test/globalObject/global_object_has_own_property.cc +28 -28
  240. package/vendor/node-addon-api/test/globalObject/global_object_has_own_property.js +48 -48
  241. package/vendor/node-addon-api/test/globalObject/global_object_set_property.cc +30 -30
  242. package/vendor/node-addon-api/test/globalObject/global_object_set_property.js +58 -58
  243. package/vendor/node-addon-api/test/handlescope.cc +60 -60
  244. package/vendor/node-addon-api/test/handlescope.js +14 -14
  245. package/vendor/node-addon-api/test/index.js +136 -136
  246. package/vendor/node-addon-api/test/maybe/check.cc +23 -23
  247. package/vendor/node-addon-api/test/maybe/index.js +38 -38
  248. package/vendor/node-addon-api/test/memory_management.cc +17 -17
  249. package/vendor/node-addon-api/test/memory_management.js +9 -9
  250. package/vendor/node-addon-api/test/movable_callbacks.cc +23 -23
  251. package/vendor/node-addon-api/test/movable_callbacks.js +21 -21
  252. package/vendor/node-addon-api/test/name.cc +108 -108
  253. package/vendor/node-addon-api/test/name.js +59 -59
  254. package/vendor/node-addon-api/test/napi_child.js +14 -14
  255. package/vendor/node-addon-api/test/object/delete_property.cc +38 -38
  256. package/vendor/node-addon-api/test/object/delete_property.js +41 -41
  257. package/vendor/node-addon-api/test/object/finalizer.cc +29 -29
  258. package/vendor/node-addon-api/test/object/finalizer.js +28 -28
  259. package/vendor/node-addon-api/test/object/get_property.cc +34 -34
  260. package/vendor/node-addon-api/test/object/get_property.js +40 -40
  261. package/vendor/node-addon-api/test/object/has_own_property.cc +34 -34
  262. package/vendor/node-addon-api/test/object/has_own_property.js +34 -34
  263. package/vendor/node-addon-api/test/object/has_property.cc +38 -38
  264. package/vendor/node-addon-api/test/object/has_property.js +37 -37
  265. package/vendor/node-addon-api/test/object/object.cc +348 -348
  266. package/vendor/node-addon-api/test/object/object.js +217 -217
  267. package/vendor/node-addon-api/test/object/object_deprecated.cc +66 -66
  268. package/vendor/node-addon-api/test/object/object_deprecated.js +47 -47
  269. package/vendor/node-addon-api/test/object/object_freeze_seal.cc +25 -25
  270. package/vendor/node-addon-api/test/object/object_freeze_seal.js +61 -61
  271. package/vendor/node-addon-api/test/object/set_property.cc +37 -37
  272. package/vendor/node-addon-api/test/object/set_property.js +29 -29
  273. package/vendor/node-addon-api/test/object/subscript_operator.cc +42 -42
  274. package/vendor/node-addon-api/test/object/subscript_operator.js +17 -17
  275. package/vendor/node-addon-api/test/object_reference.cc +219 -219
  276. package/vendor/node-addon-api/test/object_reference.js +259 -259
  277. package/vendor/node-addon-api/test/objectwrap.cc +268 -268
  278. package/vendor/node-addon-api/test/objectwrap.js +284 -284
  279. package/vendor/node-addon-api/test/objectwrap_constructor_exception.cc +26 -26
  280. package/vendor/node-addon-api/test/objectwrap_constructor_exception.js +18 -18
  281. package/vendor/node-addon-api/test/objectwrap_multiple_inheritance.cc +30 -30
  282. package/vendor/node-addon-api/test/objectwrap_multiple_inheritance.js +13 -13
  283. package/vendor/node-addon-api/test/objectwrap_removewrap.cc +45 -45
  284. package/vendor/node-addon-api/test/objectwrap_removewrap.js +40 -40
  285. package/vendor/node-addon-api/test/objectwrap_worker_thread.js +19 -19
  286. package/vendor/node-addon-api/test/promise.cc +29 -29
  287. package/vendor/node-addon-api/test/promise.js +18 -18
  288. package/vendor/node-addon-api/test/reference.cc +24 -24
  289. package/vendor/node-addon-api/test/reference.js +14 -14
  290. package/vendor/node-addon-api/test/run_script.cc +56 -56
  291. package/vendor/node-addon-api/test/run_script.js +45 -45
  292. package/vendor/node-addon-api/test/symbol.cc +79 -79
  293. package/vendor/node-addon-api/test/symbol.js +73 -73
  294. package/vendor/node-addon-api/test/testUtil.js +54 -54
  295. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function.cc +195 -195
  296. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function.js +188 -188
  297. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ctx.cc +63 -63
  298. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ctx.js +12 -12
  299. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_existing_tsfn.cc +115 -115
  300. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_existing_tsfn.js +14 -14
  301. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ptr.cc +26 -26
  302. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_ptr.js +7 -7
  303. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_sum.cc +225 -225
  304. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_sum.js +59 -59
  305. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_unref.cc +42 -42
  306. package/vendor/node-addon-api/test/threadsafe_function/threadsafe_function_unref.js +53 -53
  307. package/vendor/node-addon-api/test/thunking_manual.cc +140 -140
  308. package/vendor/node-addon-api/test/thunking_manual.js +17 -17
  309. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function.cc +215 -215
  310. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function.js +188 -188
  311. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ctx.cc +68 -68
  312. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ctx.js +12 -12
  313. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_existing_tsfn.cc +127 -127
  314. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_existing_tsfn.js +14 -14
  315. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ptr.cc +28 -28
  316. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_ptr.js +7 -7
  317. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_sum.cc +237 -237
  318. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_sum.js +59 -59
  319. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_unref.cc +53 -53
  320. package/vendor/node-addon-api/test/typed_threadsafe_function/typed_threadsafe_function_unref.js +53 -53
  321. package/vendor/node-addon-api/test/typedarray-bigint.js +58 -58
  322. package/vendor/node-addon-api/test/typedarray.cc +216 -216
  323. package/vendor/node-addon-api/test/typedarray.js +69 -69
  324. package/vendor/node-addon-api/test/version_management.cc +27 -27
  325. package/vendor/node-addon-api/test/version_management.js +31 -31
  326. package/vendor/node-addon-api/tools/README.md +73 -73
  327. package/vendor/node-addon-api/tools/check-napi.js +100 -100
  328. package/vendor/node-addon-api/tools/clang-format.js +68 -68
  329. package/vendor/node-addon-api/tools/conversion.js +309 -309
  330. package/vendor/node-addon-api/tools/eslint-format.js +71 -71
@@ -1,293 +1,293 @@
1
- NOTE: The default branch has been renamed!
2
- master is now named main
3
-
4
- If you have a local clone, you can update it by running:
5
-
6
- ```shell
7
- git branch -m master main
8
- git fetch origin
9
- git branch -u origin/main main
10
- ```
11
-
12
- # **node-addon-api module**
13
- This module contains **header-only C++ wrapper classes** which simplify
14
- the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
15
- provided by Node.js when using C++. It provides a C++ object model
16
- and exception handling semantics with low overhead.
17
-
18
- There are three options for implementing addons: Node-API, nan, or direct
19
- use of internal V8, libuv and Node.js libraries. Unless there is a need for
20
- direct access to functionality which is not exposed by Node-API as outlined
21
- in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)
22
- in Node.js core, use Node-API. Refer to
23
- [C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
24
- for more information on Node-API.
25
-
26
- Node-API is an ABI stable C interface provided by Node.js for building native
27
- addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore)
28
- and is maintained as part of Node.js itself. It is intended to insulate
29
- native addons from changes in the underlying JavaScript engine and allow
30
- modules compiled for one version to run on later versions of Node.js without
31
- recompilation.
32
-
33
- The `node-addon-api` module, which is not part of Node.js, preserves the benefits
34
- of the Node-API as it consists only of inline code that depends only on the stable API
35
- provided by Node-API. As such, modules built against one version of Node.js
36
- using node-addon-api should run without having to be rebuilt with newer versions
37
- of Node.js.
38
-
39
- It is important to remember that *other* Node.js interfaces such as
40
- `libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
41
- Node.js major versions. Thus, an addon must use Node-API and/or `node-addon-api`
42
- exclusively and build against a version of Node.js that includes an
43
- implementation of Node-API (meaning an active LTS version of Node.js) in
44
- order to benefit from ABI stability across Node.js major versions. Node.js
45
- provides an [ABI stability guide][] containing a detailed explanation of ABI
46
- stability in general, and the Node-API ABI stability guarantee in particular.
47
-
48
- As new APIs are added to Node-API, node-addon-api must be updated to provide
49
- wrappers for those new APIs. For this reason node-addon-api provides
50
- methods that allow callers to obtain the underlying Node-API handles so
51
- direct calls to Node-API and the use of the objects/methods provided by
52
- node-addon-api can be used together. For example, in order to be able
53
- to use an API for which the node-addon-api does not yet provide a wrapper.
54
-
55
- APIs exposed by node-addon-api are generally used to create and
56
- manipulate JavaScript values. Concepts and operations generally map
57
- to ideas specified in the **ECMA262 Language Specification**.
58
-
59
- The [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an
60
- excellent orientation and tips for developers just getting started with Node-API
61
- and node-addon-api.
62
-
63
- - **[Setup](#setup)**
64
- - **[API Documentation](#api)**
65
- - **[Examples](#examples)**
66
- - **[Tests](#tests)**
67
- - **[More resource and info about native Addons](#resources)**
68
- - **[Badges](#badges)**
69
- - **[Code of Conduct](CODE_OF_CONDUCT.md)**
70
- - **[Contributors](#contributors)**
71
- - **[License](#license)**
72
-
73
- ## **Current version: 4.3.0**
74
-
75
- (See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
76
-
77
- [![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)
78
-
79
- <a name="setup"></a>
80
-
81
- node-addon-api is based on [Node-API](https://nodejs.org/api/n-api.html) and supports using different Node-API versions.
82
- This allows addons built with it to run with Node.js versions which support the targeted Node-API version.
83
- **However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
84
- every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
85
-
86
- The oldest Node.js version supported by the current version of node-addon-api is Node.js 12.x.
87
-
88
- ## Setup
89
- - [Installation and usage](doc/setup.md)
90
- - [node-gyp](doc/node-gyp.md)
91
- - [cmake-js](doc/cmake-js.md)
92
- - [Conversion tool](doc/conversion-tool.md)
93
- - [Checker tool](doc/checker-tool.md)
94
- - [Generator](doc/generator.md)
95
- - [Prebuild tools](doc/prebuild_tools.md)
96
-
97
- <a name="api"></a>
98
-
99
- ### **API Documentation**
100
-
101
- The following is the documentation for node-addon-api.
102
-
103
- - [Full Class Hierarchy](doc/hierarchy.md)
104
- - [Addon Structure](doc/addon.md)
105
- - Data Types:
106
- - [Env](doc/env.md)
107
- - [CallbackInfo](doc/callbackinfo.md)
108
- - [Reference](doc/reference.md)
109
- - [Value](doc/value.md)
110
- - [Name](doc/name.md)
111
- - [Symbol](doc/symbol.md)
112
- - [String](doc/string.md)
113
- - [Number](doc/number.md)
114
- - [Date](doc/date.md)
115
- - [BigInt](doc/bigint.md)
116
- - [Boolean](doc/boolean.md)
117
- - [External](doc/external.md)
118
- - [Object](doc/object.md)
119
- - [Array](doc/array.md)
120
- - [ObjectReference](doc/object_reference.md)
121
- - [PropertyDescriptor](doc/property_descriptor.md)
122
- - [Function](doc/function.md)
123
- - [FunctionReference](doc/function_reference.md)
124
- - [ObjectWrap](doc/object_wrap.md)
125
- - [ClassPropertyDescriptor](doc/class_property_descriptor.md)
126
- - [Buffer](doc/buffer.md)
127
- - [ArrayBuffer](doc/array_buffer.md)
128
- - [TypedArray](doc/typed_array.md)
129
- - [TypedArrayOf](doc/typed_array_of.md)
130
- - [DataView](doc/dataview.md)
131
- - [Error Handling](doc/error_handling.md)
132
- - [Error](doc/error.md)
133
- - [TypeError](doc/type_error.md)
134
- - [RangeError](doc/range_error.md)
135
- - [Object Lifetime Management](doc/object_lifetime_management.md)
136
- - [HandleScope](doc/handle_scope.md)
137
- - [EscapableHandleScope](doc/escapable_handle_scope.md)
138
- - [Memory Management](doc/memory_management.md)
139
- - [Async Operations](doc/async_operations.md)
140
- - [AsyncWorker](doc/async_worker.md)
141
- - [AsyncContext](doc/async_context.md)
142
- - [AsyncWorker Variants](doc/async_worker_variants.md)
143
- - [Thread-safe Functions](doc/threadsafe.md)
144
- - [ThreadSafeFunction](doc/threadsafe_function.md)
145
- - [TypedThreadSafeFunction](doc/typed_threadsafe_function.md)
146
- - [Promises](doc/promises.md)
147
- - [Version management](doc/version_management.md)
148
-
149
- <a name="examples"></a>
150
-
151
- ### **Examples**
152
-
153
- Are you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**
154
-
155
- - **[Hello World](https://github.com/nodejs/node-addon-examples/tree/HEAD/1_hello_world/node-addon-api)**
156
- - **[Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/HEAD/2_function_arguments/node-addon-api)**
157
- - **[Callbacks](https://github.com/nodejs/node-addon-examples/tree/HEAD/3_callbacks/node-addon-api)**
158
- - **[Object factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/4_object_factory/node-addon-api)**
159
- - **[Function factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/5_function_factory/node-addon-api)**
160
- - **[Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/HEAD/6_object_wrap/node-addon-api)**
161
- - **[Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/HEAD/7_factory_wrap/node-addon-api)**
162
- - **[Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/HEAD/8_passing_wrapped/node-addon-api)**
163
-
164
- <a name="tests"></a>
165
-
166
- ### **Tests**
167
-
168
- To run the **node-addon-api** tests do:
169
-
170
- ```
171
- npm install
172
- npm test
173
- ```
174
-
175
- To avoid testing the deprecated portions of the API run
176
- ```
177
- npm install
178
- npm test --disable-deprecated
179
- ```
180
-
181
- To run the tests targeting a specific version of Node-API run
182
- ```
183
- npm install
184
- export NAPI_VERSION=X
185
- npm test --NAPI_VERSION=X
186
- ```
187
-
188
- where X is the version of Node-API you want to target.
189
-
190
- ### **Debug**
191
-
192
- To run the **node-addon-api** tests with `--debug` option:
193
-
194
- ```
195
- npm run-script dev
196
- ```
197
-
198
- If you want faster build, you might use the following option:
199
-
200
- ```
201
- npm run-script dev:incremental
202
- ```
203
-
204
- Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/HEAD/test)**
205
-
206
- ### **Benchmarks**
207
-
208
- You can run the available benchmarks using the following command:
209
-
210
- ```
211
- npm run-script benchmark
212
- ```
213
-
214
- See [benchmark/README.md](benchmark/README.md) for more details about running and adding benchmarks.
215
-
216
- <a name="resources"></a>
217
-
218
- ### **More resource and info about native Addons**
219
- - **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)**
220
- - **[Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)**
221
- - **[Node-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)**
222
- - **[How We Migrated Realm JavaScript From NAN to Node-API](https://developer.mongodb.com/article/realm-javascript-nan-to-n-api)**
223
-
224
- As node-addon-api's core mission is to expose the plain C Node-API as C++
225
- wrappers, tools that facilitate n-api/node-addon-api providing more
226
- convenient patterns on developing a Node.js add-ons with n-api/node-addon-api
227
- can be published to NPM as standalone packages. It is also recommended to tag
228
- such packages with `node-addon-api` to provide more visibility to the community.
229
-
230
- Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).
231
-
232
- <a name="other-bindings"></a>
233
-
234
- ### **Other bindings**
235
-
236
- - **[napi-rs](https://napi.rs)** - (`Rust`)
237
-
238
- <a name="badges"></a>
239
-
240
- ### **Badges**
241
-
242
- The use of badges is recommended to indicate the minimum version of Node-API
243
- required for the module. This helps to determine which Node.js major versions are
244
- supported. Addon maintainers can consult the [Node-API support matrix][] to determine
245
- which Node.js versions provide a given Node-API version. The following badges are
246
- available:
247
-
248
- ![Node-API v1 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v1%20Badge.svg)
249
- ![Node-API v2 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v2%20Badge.svg)
250
- ![Node-API v3 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v3%20Badge.svg)
251
- ![Node-API v4 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v4%20Badge.svg)
252
- ![Node-API v5 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v5%20Badge.svg)
253
- ![Node-API v6 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v6%20Badge.svg)
254
- ![Node-API v7 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v7%20Badge.svg)
255
- ![Node-API v8 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v8%20Badge.svg)
256
- ![Node-API Experimental Version Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20Experimental%20Version%20Badge.svg)
257
-
258
- ## **Contributing**
259
-
260
- We love contributions from the community to **node-addon-api**!
261
- See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
262
-
263
- <a name="contributors"></a>
264
-
265
- ## Team members
266
-
267
- ### Active
268
- | Name | GitHub Link |
269
- | ------------------- | ----------------------------------------------------- |
270
- | Anna Henningsen | [addaleax](https://github.com/addaleax) |
271
- | Chengzhong Wu | [legendecas](https://github.com/legendecas) |
272
- | Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |
273
- | Jim Schlight | [jschlight](https://github.com/jschlight) |
274
- | Michael Dawson | [mhdawson](https://github.com/mhdawson) |
275
- | Kevin Eady | [KevinEady](https://github.com/KevinEady)
276
- | Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) |
277
-
278
- ### Emeritus
279
- | Name | GitHub Link |
280
- | ------------------- | ----------------------------------------------------- |
281
- | Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |
282
- | Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |
283
- | Jason Ginchereau | [jasongin](https://github.com/jasongin) |
284
- | Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
285
- | Sampson Gao | [sampsongao](https://github.com/sampsongao) |
286
- | Taylor Woll | [boingoing](https://github.com/boingoing) |
287
-
288
- <a name="license"></a>
289
-
290
- Licensed under [MIT](./LICENSE.md)
291
-
292
- [ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/
293
- [Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix
1
+ NOTE: The default branch has been renamed!
2
+ master is now named main
3
+
4
+ If you have a local clone, you can update it by running:
5
+
6
+ ```shell
7
+ git branch -m master main
8
+ git fetch origin
9
+ git branch -u origin/main main
10
+ ```
11
+
12
+ # **node-addon-api module**
13
+ This module contains **header-only C++ wrapper classes** which simplify
14
+ the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
15
+ provided by Node.js when using C++. It provides a C++ object model
16
+ and exception handling semantics with low overhead.
17
+
18
+ There are three options for implementing addons: Node-API, nan, or direct
19
+ use of internal V8, libuv and Node.js libraries. Unless there is a need for
20
+ direct access to functionality which is not exposed by Node-API as outlined
21
+ in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)
22
+ in Node.js core, use Node-API. Refer to
23
+ [C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
24
+ for more information on Node-API.
25
+
26
+ Node-API is an ABI stable C interface provided by Node.js for building native
27
+ addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore)
28
+ and is maintained as part of Node.js itself. It is intended to insulate
29
+ native addons from changes in the underlying JavaScript engine and allow
30
+ modules compiled for one version to run on later versions of Node.js without
31
+ recompilation.
32
+
33
+ The `node-addon-api` module, which is not part of Node.js, preserves the benefits
34
+ of the Node-API as it consists only of inline code that depends only on the stable API
35
+ provided by Node-API. As such, modules built against one version of Node.js
36
+ using node-addon-api should run without having to be rebuilt with newer versions
37
+ of Node.js.
38
+
39
+ It is important to remember that *other* Node.js interfaces such as
40
+ `libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
41
+ Node.js major versions. Thus, an addon must use Node-API and/or `node-addon-api`
42
+ exclusively and build against a version of Node.js that includes an
43
+ implementation of Node-API (meaning an active LTS version of Node.js) in
44
+ order to benefit from ABI stability across Node.js major versions. Node.js
45
+ provides an [ABI stability guide][] containing a detailed explanation of ABI
46
+ stability in general, and the Node-API ABI stability guarantee in particular.
47
+
48
+ As new APIs are added to Node-API, node-addon-api must be updated to provide
49
+ wrappers for those new APIs. For this reason node-addon-api provides
50
+ methods that allow callers to obtain the underlying Node-API handles so
51
+ direct calls to Node-API and the use of the objects/methods provided by
52
+ node-addon-api can be used together. For example, in order to be able
53
+ to use an API for which the node-addon-api does not yet provide a wrapper.
54
+
55
+ APIs exposed by node-addon-api are generally used to create and
56
+ manipulate JavaScript values. Concepts and operations generally map
57
+ to ideas specified in the **ECMA262 Language Specification**.
58
+
59
+ The [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an
60
+ excellent orientation and tips for developers just getting started with Node-API
61
+ and node-addon-api.
62
+
63
+ - **[Setup](#setup)**
64
+ - **[API Documentation](#api)**
65
+ - **[Examples](#examples)**
66
+ - **[Tests](#tests)**
67
+ - **[More resource and info about native Addons](#resources)**
68
+ - **[Badges](#badges)**
69
+ - **[Code of Conduct](CODE_OF_CONDUCT.md)**
70
+ - **[Contributors](#contributors)**
71
+ - **[License](#license)**
72
+
73
+ ## **Current version: 4.3.0**
74
+
75
+ (See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
76
+
77
+ [![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)
78
+
79
+ <a name="setup"></a>
80
+
81
+ node-addon-api is based on [Node-API](https://nodejs.org/api/n-api.html) and supports using different Node-API versions.
82
+ This allows addons built with it to run with Node.js versions which support the targeted Node-API version.
83
+ **However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
84
+ every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
85
+
86
+ The oldest Node.js version supported by the current version of node-addon-api is Node.js 12.x.
87
+
88
+ ## Setup
89
+ - [Installation and usage](doc/setup.md)
90
+ - [node-gyp](doc/node-gyp.md)
91
+ - [cmake-js](doc/cmake-js.md)
92
+ - [Conversion tool](doc/conversion-tool.md)
93
+ - [Checker tool](doc/checker-tool.md)
94
+ - [Generator](doc/generator.md)
95
+ - [Prebuild tools](doc/prebuild_tools.md)
96
+
97
+ <a name="api"></a>
98
+
99
+ ### **API Documentation**
100
+
101
+ The following is the documentation for node-addon-api.
102
+
103
+ - [Full Class Hierarchy](doc/hierarchy.md)
104
+ - [Addon Structure](doc/addon.md)
105
+ - Data Types:
106
+ - [Env](doc/env.md)
107
+ - [CallbackInfo](doc/callbackinfo.md)
108
+ - [Reference](doc/reference.md)
109
+ - [Value](doc/value.md)
110
+ - [Name](doc/name.md)
111
+ - [Symbol](doc/symbol.md)
112
+ - [String](doc/string.md)
113
+ - [Number](doc/number.md)
114
+ - [Date](doc/date.md)
115
+ - [BigInt](doc/bigint.md)
116
+ - [Boolean](doc/boolean.md)
117
+ - [External](doc/external.md)
118
+ - [Object](doc/object.md)
119
+ - [Array](doc/array.md)
120
+ - [ObjectReference](doc/object_reference.md)
121
+ - [PropertyDescriptor](doc/property_descriptor.md)
122
+ - [Function](doc/function.md)
123
+ - [FunctionReference](doc/function_reference.md)
124
+ - [ObjectWrap](doc/object_wrap.md)
125
+ - [ClassPropertyDescriptor](doc/class_property_descriptor.md)
126
+ - [Buffer](doc/buffer.md)
127
+ - [ArrayBuffer](doc/array_buffer.md)
128
+ - [TypedArray](doc/typed_array.md)
129
+ - [TypedArrayOf](doc/typed_array_of.md)
130
+ - [DataView](doc/dataview.md)
131
+ - [Error Handling](doc/error_handling.md)
132
+ - [Error](doc/error.md)
133
+ - [TypeError](doc/type_error.md)
134
+ - [RangeError](doc/range_error.md)
135
+ - [Object Lifetime Management](doc/object_lifetime_management.md)
136
+ - [HandleScope](doc/handle_scope.md)
137
+ - [EscapableHandleScope](doc/escapable_handle_scope.md)
138
+ - [Memory Management](doc/memory_management.md)
139
+ - [Async Operations](doc/async_operations.md)
140
+ - [AsyncWorker](doc/async_worker.md)
141
+ - [AsyncContext](doc/async_context.md)
142
+ - [AsyncWorker Variants](doc/async_worker_variants.md)
143
+ - [Thread-safe Functions](doc/threadsafe.md)
144
+ - [ThreadSafeFunction](doc/threadsafe_function.md)
145
+ - [TypedThreadSafeFunction](doc/typed_threadsafe_function.md)
146
+ - [Promises](doc/promises.md)
147
+ - [Version management](doc/version_management.md)
148
+
149
+ <a name="examples"></a>
150
+
151
+ ### **Examples**
152
+
153
+ Are you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**
154
+
155
+ - **[Hello World](https://github.com/nodejs/node-addon-examples/tree/HEAD/1_hello_world/node-addon-api)**
156
+ - **[Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/HEAD/2_function_arguments/node-addon-api)**
157
+ - **[Callbacks](https://github.com/nodejs/node-addon-examples/tree/HEAD/3_callbacks/node-addon-api)**
158
+ - **[Object factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/4_object_factory/node-addon-api)**
159
+ - **[Function factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/5_function_factory/node-addon-api)**
160
+ - **[Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/HEAD/6_object_wrap/node-addon-api)**
161
+ - **[Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/HEAD/7_factory_wrap/node-addon-api)**
162
+ - **[Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/HEAD/8_passing_wrapped/node-addon-api)**
163
+
164
+ <a name="tests"></a>
165
+
166
+ ### **Tests**
167
+
168
+ To run the **node-addon-api** tests do:
169
+
170
+ ```
171
+ npm install
172
+ npm test
173
+ ```
174
+
175
+ To avoid testing the deprecated portions of the API run
176
+ ```
177
+ npm install
178
+ npm test --disable-deprecated
179
+ ```
180
+
181
+ To run the tests targeting a specific version of Node-API run
182
+ ```
183
+ npm install
184
+ export NAPI_VERSION=X
185
+ npm test --NAPI_VERSION=X
186
+ ```
187
+
188
+ where X is the version of Node-API you want to target.
189
+
190
+ ### **Debug**
191
+
192
+ To run the **node-addon-api** tests with `--debug` option:
193
+
194
+ ```
195
+ npm run-script dev
196
+ ```
197
+
198
+ If you want faster build, you might use the following option:
199
+
200
+ ```
201
+ npm run-script dev:incremental
202
+ ```
203
+
204
+ Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/HEAD/test)**
205
+
206
+ ### **Benchmarks**
207
+
208
+ You can run the available benchmarks using the following command:
209
+
210
+ ```
211
+ npm run-script benchmark
212
+ ```
213
+
214
+ See [benchmark/README.md](benchmark/README.md) for more details about running and adding benchmarks.
215
+
216
+ <a name="resources"></a>
217
+
218
+ ### **More resource and info about native Addons**
219
+ - **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)**
220
+ - **[Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)**
221
+ - **[Node-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)**
222
+ - **[How We Migrated Realm JavaScript From NAN to Node-API](https://developer.mongodb.com/article/realm-javascript-nan-to-n-api)**
223
+
224
+ As node-addon-api's core mission is to expose the plain C Node-API as C++
225
+ wrappers, tools that facilitate n-api/node-addon-api providing more
226
+ convenient patterns on developing a Node.js add-ons with n-api/node-addon-api
227
+ can be published to NPM as standalone packages. It is also recommended to tag
228
+ such packages with `node-addon-api` to provide more visibility to the community.
229
+
230
+ Quick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).
231
+
232
+ <a name="other-bindings"></a>
233
+
234
+ ### **Other bindings**
235
+
236
+ - **[napi-rs](https://napi.rs)** - (`Rust`)
237
+
238
+ <a name="badges"></a>
239
+
240
+ ### **Badges**
241
+
242
+ The use of badges is recommended to indicate the minimum version of Node-API
243
+ required for the module. This helps to determine which Node.js major versions are
244
+ supported. Addon maintainers can consult the [Node-API support matrix][] to determine
245
+ which Node.js versions provide a given Node-API version. The following badges are
246
+ available:
247
+
248
+ ![Node-API v1 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v1%20Badge.svg)
249
+ ![Node-API v2 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v2%20Badge.svg)
250
+ ![Node-API v3 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v3%20Badge.svg)
251
+ ![Node-API v4 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v4%20Badge.svg)
252
+ ![Node-API v5 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v5%20Badge.svg)
253
+ ![Node-API v6 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v6%20Badge.svg)
254
+ ![Node-API v7 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v7%20Badge.svg)
255
+ ![Node-API v8 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v8%20Badge.svg)
256
+ ![Node-API Experimental Version Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20Experimental%20Version%20Badge.svg)
257
+
258
+ ## **Contributing**
259
+
260
+ We love contributions from the community to **node-addon-api**!
261
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
262
+
263
+ <a name="contributors"></a>
264
+
265
+ ## Team members
266
+
267
+ ### Active
268
+ | Name | GitHub Link |
269
+ | ------------------- | ----------------------------------------------------- |
270
+ | Anna Henningsen | [addaleax](https://github.com/addaleax) |
271
+ | Chengzhong Wu | [legendecas](https://github.com/legendecas) |
272
+ | Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |
273
+ | Jim Schlight | [jschlight](https://github.com/jschlight) |
274
+ | Michael Dawson | [mhdawson](https://github.com/mhdawson) |
275
+ | Kevin Eady | [KevinEady](https://github.com/KevinEady)
276
+ | Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) |
277
+
278
+ ### Emeritus
279
+ | Name | GitHub Link |
280
+ | ------------------- | ----------------------------------------------------- |
281
+ | Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |
282
+ | Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |
283
+ | Jason Ginchereau | [jasongin](https://github.com/jasongin) |
284
+ | Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
285
+ | Sampson Gao | [sampsongao](https://github.com/sampsongao) |
286
+ | Taylor Woll | [boingoing](https://github.com/boingoing) |
287
+
288
+ <a name="license"></a>
289
+
290
+ Licensed under [MIT](./LICENSE.md)
291
+
292
+ [ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/
293
+ [Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix