node-addon-api - npm Package Versions

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)

2020-12-17 Version 3.1.0, @NickNaso

Notable changes:

API

• Added Napi::TypedThreadSafeFunction class that is a new implementation for thread-safe functions.
• Fixed leak on Napi::AsyncProgressWorkerBase.
• Fixed empty data on Napi::AsyncProgressWorker::OnProgress caused by race conditions of Napi::AsyncProgressWorker.
• Added Napi::ArrayBuffer::Detach() and Napi::ArrayBuffer::IsDetached().
• Fixed problem on Napi::FinalizeCallback it needs to create a Napi::HandleScope when it calls Napi::ObjectWrap::~ObjectWrap().

Documentation

• Added documentation for Napi::TypedThreadSafeFunction.
• Removed unsued Doxygen file.
• Clarified when to use N-API.
• Added support information.
• Some minor corrections all over the documentation.

TEST

• Added test for Napi::TypedThreadSafeFunction.
• Fixed testing for specific N-API version.
• Some minor corrections all over the test suite.

TOOL

• Setup github actions for tests.
• Added stale action.
• Removed sudo tag from Travis CI.
• Added clang-format.
• Added pre-commit package for linting.

Commits

• [ff642c5b85] - doc: fix tsfn docs to reflect true implementation (#860) (Kevin Eady)
• [86feeebf54] - src: empty data OnProgress in AsyncProgressWorker (legendecas) #853
• [a7fb5fb31c] - action: add stale action (#856) (Michael Dawson)
• [fd44609885] - chore: setup github actions for tests (#854) (legendecas) #854
• [c52ace4813] - script: fix complains that js files are not supported on npm run lint:fix (#852) (legendecas)
• [b4a3364ad5] - doc: remove unused Doxygen file (#851) (Michael Dawson)
• [b810466ae2] - doc: clarify when to use N-API (#849) (Michael Dawson)
• [528b9f6832] - test: remove sudo from travis (#850) (Michael Dawson)
• [4bb680de4e] - Remove misleading sentence (#847) (Nikolai Vavilov) #847
• [48e6b584a3] - Merge pull request #742 from KevinEady/contexted-tsfn-api-gcc-4 (Gabriel Schulhof)
• [d5e37210cc] - tools: print more instructions on clang-format check failed (#846) (legendecas) #846
• [d9e11ff2c9] - doc: add support info (#843) (Michael Dawson) #843
• [356e93d69a] - test: fixup testing for specific N-API version (#840) (Michael Dawson) #840
• [5e5b9ce1b7] - Apply formatting changes (Kevin Eady)
• [559ad8c0c0] - Merge remote-tracking branch 'upstream/master' into contexted-tsfn-api-gcc-4 (Kevin Eady)
• [c24c455ced] - Rename to TypedThreadSafeFunction (Kevin Eady)
• [63b43f4125] - test: fix buildType bug objectwrap_worker_thread (raisinten) #837
• [6321f2ba1a] - test: fix typos in addon_build/index.js (raisinten) #838
• [59c6a6aeb0] - fix: git-clang-format doesn't recognize no changes requested on given files (#835) (legendecas)
• [1427b3ef78] - src: create a HandleScope in FinalizeCallback (blagoev) #832
• [8fb5820557] - build: add incremental clang-format checks (legendecas) #819
• [2c02d317e5] - build: add pre-commit package for linting (#823) (Kevin Eady)
• [1b52c28eb8] - Clean up AsyncProgressWorker documentation (#831) (mastergberry)
• [4abe7cfe30] - test: rename tsfnex test files (Kevin Eady)
• [c9563caa25] - src: add ArrayBuffer::Detach() and ::IsDetached() (Tobias Nießen) #659
• [c79cabaed2] - doc: avoid directing users to HTTP (#828) (Tobias Nießen)
• [7a13f861ab] - doc: fix additional typo (Kevin Eady)
• [7ec9741dd2] - Merge remote-tracking branch 'upstream/master' into contexted-tsfn-api-gcc-4 (Kevin Eady)
• [f5fad239fa] - Update object_reference.md (#827) (kidneysolo)
• [35b65712c2] - Fix: some typos in documentation (#826) (Helio Frota)
• [8983383000] - Fix: some typos in the document (#825) (Ziqiu Zhao)
• [826e466ef6] - Fixed example in addon.md. (#820) (nempoBu4) #820
• [b54f5eb788] - Additional changes from review (Kevin Eady)
• [59f27dac9a] - Fix common.gypi (Kevin Eady)
• [151a914c99] - Apply documentation suggestions from code review (Kevin Eady)
• [ceb27d4949] - src: fix leak in AsyncProgressWorkerBase<DataType> (Ferdinand Holzer) #795

2020-09-18 Version 3.0.2, @NickNaso

Notable changes:

API

• Introduced include_dir for use with gyp in a scalar context.
• Added Napi::Addon to help handle the loading of a native add-on into multiple threads and or multiple times in the same thread.
• Concentrate callbacks provided to core N-API.
• Make sure wrapcallback is used.

Documentation

• Added documentation for Napi::Addon.
• Added documentation that reports the full class hierarchy.
• Added link to N-API tutorial website.
• Some minor corrections all over the documentation.

TEST

• Added tests to check the build process.
• Refactored test for threasfafe function using async/await.
• Converted tests that gc into async functions that await 10 ticks after each gc.
• Some minor corrections all over the test suite.

Commits

• [51e25f7c39] - doc: remove a file (#815) (Gabriel Schulhof)
• [8c9f1809a2] - doc: add inheritance links and other changes (Gabriel Schulhof) #798
• [6562e6b0ab] - test: added tests to check the build process (NickNaso) #808
• [a13b36c96e] - test: fix the threasfafe function test (NickNaso) #807
• [f27623ff61] - build: introduce include_dir (Lovell Fuller) #766
• [9aceea71fc] - src: concentrate callbacks provided to core N-API (Gabriel Schulhof) #786
• [2bc45bbffd] - test: refactor test to use async/await (Velmisov) #787
• [518cfdcdc1] - test: test ObjectWrap destructor - no HandleScope (David Halls) #729
• [c2cbbd9191] - doc: add link to n-api tutorial website (#794) (Jim Schlight) #794
• [1c2a8d59b5] - doc: Added required return to example (#793) (pacop) #793
• [cec2c76941] - src: wrap finalizer callback (Gabriel Schulhof) #762
• [4ce40d22a6] - test: use assert.strictEqual() (Koki Nishihara) #777
• [461e3640c6] - test: string tests together (Gabriel Schulhof) #773
• [5af645f649] - src: add Addon<T> class (Gabriel Schulhof) #749
• [6148fb4bcc] - Synchronise Node.js versions in Appveyor Windows CI with Travis (#768) (Lovell Fuller)

2020-07-13 Version 3.0.1, @NickNaso

Notable changes:

API

• Fixed the usage of Napi::Reference with Napi::TypedArray.
• Fixed Napi::ObjectWrap inheritance.

Documentation

• Updated the example for Napi::ObjectWrap.
• Added documentation for instance data APIs.
• Some minor corrections all over the documentation.

TEST

• Fixed test for Napi::ArrayBuffer and Napi::Buffer.
• Some minor corrections all over the test suite.

Commits

• [40c7926342] - build: ensure paths with spaces can be used (Lovell Fuller) #757
• [ef16dfb4a2] - doc: update ObjectWrap example (Gabriel Schulhof) #754
• [48f6762bf6] - src: add __wasm32__ guards (Gus Caplan)
• [bd2c5ec502] - Fixes issue 745. (#748) (Nicola Del Gobbo)
• [4c01af2d87] - Fix typo in CHANGELOG (#715) (Kasumi Hanazuki)
• [36e1af96d5] - src: fix use of Reference with typed arrays (Michael Dawson) #726
• [d463f02bc7] - src: fix testEnumerables on ObjectWrap (Ferdinand Holzer) #736
• [ba7ad37d44] - src: fix ObjectWrap inheritance (David Halls) #732
• [31504c862b] - doc: fix minor typo in object_wrap.md (#741) (Daniel Bevenius) #741
• [beccf2145d] - test: fix up delays for array buffer test (Michael Dawson) #737
• [45cb1d9748] - Correct AsyncProgressWorker link in README (#716) (Jeroen Janssen)
• [381c0da60c] - doc: add instance data APIs (Gabriel Schulhof) #708