node-addon-api - npm Package Versions

2023-04-20 Version 6.1.0, @NickNaso

Notable changes

API

• Enforce type checks on Napi::Value::As().
• Added Napi::TypeTaggable class.
• Defined NAPI_HAS_THREADS to make TSFN available on Emscripten.
• Defined NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED and Napi::Buffer::NewOrCopy() to handle the support for external buffers.

TEST

• Added tests for Napi::Reference<T> class.
• Added tests for copy/move semantics.
• Added tests for Napi::RangeError and Napi::TypeError class.
• Fixed inconsistent failure executing test suite.
• Added tests for Napi::ObjectReference<T> class.
• Added tests for Napi::ObjectWrap<T> class.

Documentation

• Added documentation for Napi::TypeTaggable.
• Some minor fixes all over the documentation.

Commits

• [5adb896782] - src: enforce type checks on Napi::Value::As() (#1281) (Chengzhong Wu)
• [d9faac7ec2] - Fix exits/exists typo in docs for Env::AddCleanupHook() (#1306) (Mathias Stearn)
• [164459ca03] - doc: update class hierarchy for TypeTaggable (Gabriel Schulhof) #1303
• [d01304437c] - src: interject class TypeTaggable (Gabriel Schulhof) #1298
• [d4942ccd4f] - test: Complete test coverage for Reference<T> class (#1277) (Jack)
• [a8ad7e7a7b] - test: Add tests for copy/move semantics (JckXia) #1295
• [e484327344] - Add test coverage for typed and range err (#1280) (Jack)
• [ebc7858593] - test: Update wait with a condition (#1297) (Jack)
• [0b53d885f5] - src: define NAPI_HAS_THREADS (toyobayashi) #1283
• [464610babf] - test: complete objectRefs tests (JckXia) #1274
• [b16c762a19] - src: handle no support for external buffers (legendecas) #1273
• [61b8e28720] - test: Add test covg for obj wrap (#1269) (Jack)

2023-02-03 Version 6.0.0, @NickNaso

Notable changes

API

• Added Napi::Object::TypeTag() and Napi::Object::CheckTypeTag() methods.
• Made operator napi_callback_info explicit.

TEST

• Some minor fixes all over the test suite.
• Added tests related to Napi::Object::TypeTag() and Napi::Object::CheckTypeTag() methods.
• Added tests related to Napi::CallbackScope.
• Added tests related to Napi::EscapableHandleScope.
• Added tests related to Napi::Maybe<T>.
• Added tests related to Napi::ThreadSafeFuntion.
• Changed some tests related to Napi::AsyncWorker.

Documentation

• Added documentation for Napi::Object::TypeTag() and Napi::Object::CheckTypeTag() methods.
• Added documentation about how to run a specific unit test.

TOOL

• Added x86 architecture to the CI matrix.

Commits

• [e2726193f1] - src: remove AsyncWorker move and complete tests (JckXia) #1266
• [ff969485ea] - chore: build node-addon-api against X86 (JckXia) #1276
• [a70564cdfd] - test: add cov for ThreadSafeFunction new overloads (JckXia) #1251
• [53f7cf1d48] - src: make operator napi_callback_info explicit (Kevin Eady) #1275
• [78b5a15533] - test: Add tests for ThreadSafeFunction's NonBlock function overloads (#1249) (Jack)
• [fdc6263034] - test: Add test covg for Maybe<T> (#1270) (Jack)
• [35d9d669b3] - test: add test covg for handle and escapehandle scopes (JckXia) #1263
• [021313409e] - test: add unit test covg for callbackscopes (JckXia) #1262
• [b11e4de2cf] - src: add Object::TypeTag, Object::CheckTypeTag (Kevin Eady) #1261

2023-01-13 Version 5.1.0, @NickNaso

Notable changes

API

• Fixed memory leak in Napi::AsyncProgressWorkerBase.
• Added api to get callback_info from Napi::CallBackInfo.
• Fixed erros and warning in VS 2017.
• Made Npi::Env::CleanupHook public.
• Removed Napi::TypedArray::unknown_array_type.

TEST

• Some minor fixes all over the test suite.
• Added tests related to Napi::Env.
• Added tests related to Napi::TypedArray.
• Added tests related to Napi::AsyncWorker.
• Added tests related to Napi::TypedThreadSafeFunction.
• Added tests related to Napi::Value.
• Added test related to Napi::Promise.

Documentation

• Some minor fixes all over the documentation.
• Added Napi::HandleScope example.
• Added documentation about how to run a specific unit test.

TOOL

• Added Windows with VS 2022 and Node.JS 19.x to the CI matrix.
• Fixed stale workflow.
• Updated Node.js versions on CI component.
• Added condition for Window to find eslint.

Commits

• [79a446fb9c] - Update contributors (#1265) (Kevin Eady)
• [01c61690c6] - src: napi-inl: Fix a memory leak bug in AsyncProgressWorkerBase (Ammar Faizi) #1264
• [55bd08ee26] - src: api to get callback_info from CallBackInfo (JckXia) #1253
• [ad76256714] - test: add tests related to env (JckXia) #1254
• [5c3937365d] - chore: add Windows with VS 2022 and Node.JS 19.x to the CI matrix (#1252) (Vladimir Morozov)
• [97736c93f4] - src: fix errors and warnings in VS 2017 (Vladimir Morozov) #1245
• [ad7ff92c16] - src: refactor call js wrapper (#1242) (Jack)
• [39267baf1b] - src: make CleanupHook public (Julian Mesa) #1240
• [edf630cc79] - src: fix implementation of Signal (Kevin Eady) #1216
• [de5a502f3c] - doc: Napi::Error is caught (Nicola Del Gobbo) #1241
• [10ad762807] - test: removed the usage of default_configuration. (Nicola Del Gobbo) #1226
• [e9db2adef2] - test: Add test coverage to TSFN::New() overloads (#1201) (Jack)
• [c849ad3f6a] - chore: fix stale workflow (#1228) (Richard Lau)
• [e408804ad8] - test: adding ref for threadsafefunctions (JckXia) #1222
• [a8afb2d73c] - src: remove TypedArray::unknown_array_type (Kevin Eady) #1209
• [257a52f823] - test: Add test cased for failed task cancellations (#1214) (Jack)
• [793268c59f] - test: Add test case for canceling async worker tasks (#1202) (Jack)
• [1331856ef1] - doc: add HandleScope example (#1210) (Kevin Eady)
• [d5fc875e5d] - test: remove update to process.config (#1208) (Michael Dawson)
• [30cd4a37f0] - test: add tests for .Data method (JckXia) #1203
• [225ca35963] - test: Add test coverage for "TSFN::Ref()" (#1196) (Jack)
• [5a5a213985] - Update CI component versions (#1200) (Vladimir Morozov)
• [fb27e72b0c] - doc: Update CONTRIBUTING.md (Saint Gabriel) #1185
• [e9def3ed72] - doc: Update Readme for filter conditions in unit tests (Deepak Rajamohan) #1199
• [efd67876e1] - doc: updated npm script for focused tests (Peter Šándor)
• [134961d853] - test: CallbackInfo NewTarget() basic coverage (#1048) (Peter Šándor)
• [1dfd03bdd5] - Update README.md (#1187) (Saint Gabriel)
• [576128fd19] - doc: fix typo in async_operations.md (#1189) (Tobias Nießen)
• [63d3c30ec1] - test: add tests for TypedArray (Dante Calderon) #1179
• [358ac2f080] - Fix link to CMake.js documentation (#1180) (Kyle Kovacs)
• [dc4f2bbe4a] - test: Add promise unit test (#1173) (Jenny)
• [f3124ae0ed] - doc: fix broken Napi::ThreadSafeFunction link (#1172) (Feng Yu)
• [10b440fe27] - src: reformat all code (Kevin Eady) #1160
• [33e402971e] - test: Add condition for window to find eslint (#1176) (Jack)
• [d53843b83b] - test: add missing value tests (JckXia) #1170

2022-05-02 Version 5.0.0, @NickNaso

Notable changes:

API

• Marked methods of wrapper classes const.
• Enabled wrapping Napi namespace with custom namespace.
• Added an override to Napi::Function::Call to call it with a c-style array of Napi::Value's.
• Some other minor fixes.

TEST

• Improved the test framework. Added the possibility to run subsets of tests more easily.
• Added test for Napi::AsyncContext class.
• Fixed ramdom failure on test for Napi::ThreadSafeFunction e Napi::TypedThreadSafeFunction class.
• Fixed compilation problem on debian 8 system.
• Added test for Napi::Object::Set() method.

Documentation

• Added some clarifications for Napi::ClassPropertyDescriptor.
• Added clarification about weak reference for Napi::ObjectWrap.
• Some minor fixes all over the documentation.

TOOL

• Fixed eslint configuration.
• Fixed CI configuration for Windows.
• Enabled pre-commit ClangFormat on Windows.

Commits

• [f32db917f3] - Add test coverage for async contexts (#1164) (Jack)
• [24455f88af] - src: check for tsfn in conditional_variable wait (Kevin Eady) #1168
• [40ed7ce409] - src: fix regression introduced by #874 (Michael Dawson)
• [9bea434326] - doc: added some comments to ClassPropertyDescriptor. (#1149) (Nicola Del Gobbo)
• [57c212e15f] - buld: Enable running pre-commit ClangFormat on Win (Vladimir Morozov)
• [8c46a9501a] - doc: clarify ObjectWrap weak ref behavior (#1155) (Alba Mendez)
• [01274966d5] - build: run Windows CI only on nondeprecated build configurations (#1152) (Darshan Sen)
• [b8449e17e0] - src: mark methods of wrapper classes const (Nikolai Vavilov) #874
• [5e2c1f24f8] - lint: set sourceType to 'script' (#1141) (Anna Henningsen)
• [da8af20152] - doc: mention Napi::Env arg for Finalization callback (#1139) (extremeheat)
• [5b51864a39] - src: enable wrapping Napi namespace with custom namespace (#1135) (Anna Henningsen)
• [c54aeef5fd] - Add Function::Call Napi::Value override (#1026) (rgerd)
• [e906b5a7ce] - test: fix compilation problem on debian 8 (NickNaso) #1138
• [5790c55784] - src: do not use non-static class member for constant value (#1134) (Anna Henningsen)
• [b7659db945] - Merge pull request #1130 from meixg/main (Jack)
• [a840d51d21] - Add test case for Object Set using uint32 as key (meixg)
• [2c88a7ec4c] - Merge pull request #1132 from JckXia/test-wfl-run (Jack)
• [d3a5ed3869] - Revert "window CI to running on 2019" (JckXia)
• [cee899ade5] - src: allow customization of ObjectWrap behavior (Aaron Meriwether) #1125
• [91879b4082] - remove window-latest to debug (JckXia)
• [1593ef46ee] - Testing CI run (JckXia)
• [744c8d2410] - test: enhance the test framework (Deepak Rajamohan)

2022-01-21 Version 4.3.0, @NickNaso

Notable changes:

API

• Added iterator for Napi::Object.
• Fixed usage of napi_extended_error_info in Napi::Error::New().
• Added unwrapping logic to handle graceful error handling for primitives.

TEST

• Removed travis config.
• Updated compiler used for testing.
• Added BigInt value test.
• Minor fixes all overtest suite.

Documentation

• Documentation of iterator for Napi::Object.
• Minor fixes all over documentation.

Commits

• [7046834305] - Update to use recent version of stale action (Michael Dawson)
• [293c7327ad] - Merge pull request #1075 from JckXia/handle-error-thrown (Jack)
• [706b19986d] - test: create tools/eslint-format (Doni Rubiagatra) #1080
• [e0567d098a] - Update documents (JckXia)
• [691813842e] - Refactor code. Using hard coded string instead of using symbol (JckXia)
• [7423cc5025] - Update object_wrap.md (#1094) (Alexander Floh)
• [5aab27e6e1] - doc: add blurb about SetInstanceData (Gabriel Schulhof)
• [e439222fe6] - test: add bigint value test (WenheLI) #1096
• [0dfa89f4ef] - doc: document object iterators (#1090) (Darshan Sen)
• [04b26a9d9b] - test: add first set of func Ref tests (JckXia) #1035
• [a0b3fe9197] - Replace magic value with symbol (JckXia)
• [173c5bc9d9] - Update PR based on review comments (JckXia)
• [02bcfbccfd] - Update doc and appending GUID to object property (JckXia)
• [c89f0bfb0b] - Remove un-necessary comment/iostream and updated docs to reflect on limitations with this impl (JckXia)
• [ed4d1c51c4] - Added unwrapping logic to handle graceful error handling for primitives (JckXia)
• [4663453eae] - src: fix usage of napi_extended_error_info in Error::New() (Darshan Sen) #1092
• [cb228418e6] - doc: fix typo in TypedThreadSafeFunction example (#1083) (Tobias Nießen)
• [b70acdda1f] - test: remove travis config (#1082) (Michael Dawson)
• [1404b7cbea] - test: update compiler used for testing (#1079) (Michael Dawson)
• [4351bffd53] - doc: fixup to meet lint rules (Michael Dawson) #1077
• [bd8f6e6d1a] - src: add iterator for Object (Darshan Sen)
• [d8fc7b869a] - lint: add eslint based on config-semistandard (#1067) (Doni Rubiagatra)

2021-09-17 Version 4.2.0, @NickNaso

Notable changes:

API

• Allow creating Function with move-only functor.
• Fixed casts to not be undefined behavior.

TEST

• Fixed the way to enable C++ exceptions.
• Run tests with options to prefix build root path.

Documentation

• Fixed documentation about how to enable C++ exception.
• Minor fixes all over documentation.

Commits

• [2dc1f5b66c] - Merge pull request #1065 from strager/move-only-functor (Nicola Del Gobbo)
• [2b57a4aa4c] - src: fix casts to not be undefined behavior (Anna Henningsen) #1070
• [76de4d8222] - docs: fix typos (#1068) (todoroff)
• [22a2f3c926] - docs: fix typo and formatting (#1062) (strager)
• [62b666c34c] - test: run tests with opts to prefix bld root path (Deepak Rajamohan) #1055
• [cbac3aac5d] - test: standardize unit test file names (Deepak Rajamohan) #1056
• [3e5897a78b] - src,test: allow creating Function with move-only functor (Matthew "strager" Glazar)
• [da2e754a02] - test: fix errors reported by newer compiler (Michael Dawson)
• [9aaf3b1324] - doc: fix documentation about how to enable C++ exception (#1059) (Nicola Del Gobbo) #1059
• [b2f861987f] - test: fixed the way to enable C++ exceptions. (#1061) (Nicola Del Gobbo) #1061

2021-08-25 Version 4.1.0, @NickNaso

Notable changes:

API

• Napi::Reference updated the default value to reflect the most possible values when there are any errors occurred on napi_reference_unref.
• Added the check for nullpointer on Napi::String initialization.
• Added the wraps for napi_add_env_cleanup_hook and napi_remove_env_cleanup_hook.
• Added Napi::Maybe<T> class to handle pending exception when cpp exception disabled.

TEST

• Added first set of tests for Napi::Symbol.
• Updated test suite to avoid parallel running.

Documentation

• Updated example for context sensitivity.

Commits

• [3615041423] - src: return Maybe on pending exception when cpp exception disabled (legendecas) #927
• [10564a43c6] - src: add AddCleanupHook (Kevin Eady) #1014
• [a459f5cc8f] - doc: update tests to avoid running in parallel (Michael Dawson) #1024
• [6697c51d1d] - src,test: fix up null char * exception thrown (Gabriel Schulhof) #1019
• [e02e8a4ce3] - test: add first set of symbol tests (JckXia) #972
• [da50b51398] - test: dd check for nullptr inside String init (JckXia) #1015
• [627dbf3c37] - doc: update examples for context sensitivity (Kevin Eady) #1013
• [37a9b8e753] - src: set default return value of Reference Ref/Unref to 0 (legendecas) #1004

2021-06-15 Version 4.0.0, @NickNaso

Notable changes:

API

• Fixed a crashing issue in Napi::Error::ThrowAsJavaScriptException introducing the preprocessor directive NODE_API_SWALLOW_UNTHROWABLE_EXCEPTIONS.
• Fixed compilation problem for GCC 11 and C++20.

TEST

• Added test for function reference call and contructor.

Documentation

• Updated the oldest Node.js version supported from 10.x to 12.x.

Commits

• [028107f686] - src: fix Error::ThrowAsJavaScriptException crash (rudolftam) #975
• [fed13534c5] - src: fix gcc-11 c++20 compilation (Kevin Eady) #1009
• [b75afc4d29] - test: function reference call & construct (legendecas) #1005

2021-05-28 Version 3.2.1, @NickNaso

Notable changes:

Documentation

• Fixed documentation about the oldest Node.js version supported.

Commits

• [6d41ee5a3a] - Fixed readme for new release. (NickNaso)

2021-05-17 Version 3.2.0, @NickNaso

Notable changes:

API

• Remove unnecessary symbol exposure.
• Fixed leak in Napi::ObjectWrap instance for getter and setter method.
• Added Napi::Object::Freeze and Napi::object::Seal methods.
• Napi::Reference is now copyable.

Documentation

• Added docuemtnation for Napi::Object::PropertyLValue.
• Changed all N-API references to Node-API.
• Some minor corrections all over the documentation.

TEST

• Added tests relating to fetch property from Global Object.
• Added addtiona tests for Napi::Object.
• Added test for Napi::Function contructors.
• Fixed intermittent failure for Napi::ThreadSafeFunction test.
• Some minor corrections all over the test suite.

TOOL

• Added Node.js v16.x to CI.
• Added CI configuration for Windows.
• Some fixex on linter command.

Commits

• [52721312f6] - docs: add napi-rs iin Other Bindings section (#999) (LongYinan)
• [78a6570a42] - doc: fix typo in code example (#997) (Tobias Nießen)
• [da3bd5778f] - test: fix undoc assumptions about the timing of tsfn calls (legendecas) #995
• [410cf6a81e] - src: return bool on object freeze and seal (#991) (legendecas)
• [93f1898312] - src: return bool on object set and define property (#977) (legendecas)
• [331c2ee274] - build: add Node.js v16.x to CI (#983) (legendecas)
• [b6f5eb15e6] - test: run test suites with helpers (legendecas) #976
• [fbcdf00ea0] - test: rename misspelled parameters (Tobias Nießen) #973
• [63a6c32e80] - test: fix intermittent TSFN crashes (Kevin Eady) #974
• [8f120b033f] - fix: key for wapping drawing's system condition (#970) (Kévin VOYER)
• [1c9d528d66] - doc: correct struct definition (#969) (Darshan Sen)
• [5e64d1fa61] - Added badges for Node-API v7 and v8. (#954) (Nicola Del Gobbo)
• [6ce629b3fa] - src: add pull request template (#967) (Michael Dawson)
• [98126661af] - Update CONTRIBUTING.md (#966) (Michael Dawson)
• [77350eee98] - src: added Freeze and Seal method to Object class. (NickNaso) #955
• [bc5147cc4a] - Finished tests relating to fetch property from Global Object (JckXia)
• [0127813111] - doc: unambiguously mark deprecated signatures (Tobias Nießen) #942
• [787e216105] - doc: rename N-API with Node-API (Darshan Sen) #951
• [628023689a] - src: rename N-API with Node-API on comments (NickNaso) #953
• [5c6391578f] - build: add CI configuration for Windows (NickNaso) #948
• [8ef07251ec] - doc: added some warnings for buffer and array buffer factory method. (#929) (Nicola Del Gobbo)
• [6490b1f730] - doc: sync Object::Set value arg with Value::From (#933) (Tobias Nießen)
• [7319a0d7a2] - Fix tab indent (#938) (Tobias Nießen)
• [1916cb937e] - chore: fixup linter commands (#940) (legendecas)
• [fc4585fa23] - test: dd tests for Function constructors (JoseExposito) #937
• [87b7aae469] - doc: warn about SuppressDestruct() (#926) (Anna Henningsen)
• [71494a49a3] - src,doc: refactor to replace typedefs with usings (Darshan Sen) #910
• [298ff8d9d2] - test: add additional tests for Object (JoseExposito) #923
• [8a1147b430] - revert: src: add additional tests for Function (Michael Dawson)
• [bb56ffaa6f] - doc: fix documentation for object api (Nicola Del Gobbo) #931
• [3b8bddab49] - src: add additional tests for Function (José Expósito) #928
• [74ab50c775] - src: allow references to be copyable in APIs (legendecas) #915
• [929709d0fe] - doc: add propertylvalue.md (#925) (Gabriel Schulhof)
• [69d0d98be4] - fixup (Anna Henningsen)
• [46e41d961b] - fixup (Anna Henningsen)
• [1af1642fb7] - doc: warn about SuppressDestruct() (Anna Henningsen)
• [12c548b2ff] - tools: fix error detection (#914) (Darshan Sen)
• [458d895d5b] - packaging: list files to be published to npm (Lovell Fuller) #889
• [f7ed2490d4] - test: remove outdated V8 flag (Darshan Sen) #895
• [a575a6ec60] - src: fix leak in ObjectWrap instance set/getters (Kevin Eady) #899
• [b6e844e0b0] - doc: fix spelling of "targeted" and "targeting" (#904) (Tobias Nießen)
• [4d856f6e91] - src: remove unnecessary symbol exposure (Gabriel Schulhof) #896
• [f35bb7d0d7] - doc: Update GitHub URL references from 'master' to 'HEAD' (#898) (Jim Schlight)
• [286ae215d1] - Add warning about branch rename (Michael Dawson)
• [a4a7b28288] - Update branch references from master to main (#886) (Jim Schlight)
• [a2ad0a107a] - docs: add NAN to N-API resource link (#880) (kidneysolo)
• [1c040eeb63] - test: load testModules automatically (raisinten) #876
• [bf478e4496] - src: use NAPI_NOEXCEPT macro instead of noexcept (NickNaso) #864
• [744705f2eb] - test: refactor remove repeated execution index.js (raisinten) #839
• [db62e3c811] - Update team members (Michael Dawson)