node-addon-api - npm Package Versions

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

2020-04-30 Version 3.0.0, @NickNaso

Notable changes:

API

• Napi::Object added templated property descriptors.
• Napi::ObjectWrap added templated methods.
• Napi::ObjectWrap the wrap is removed only on failure.
• Napi::ObjectWrap the constructor's exceptions are gracefully handled.
• Napi::Function added templated factory functions.
• Added Env::RunScript method to run JavaScript code contained in a string.
• Added templated version of Napi::Function.
• Added benchmarking framework.
• Added support for native addon instance data.
• Added Napi::AsyncProgressQueueWorker api.
• Changed the guards to NAPI_VERSION > 5.
• Removed N-API implementation (v6.x and v8.x support).
• Napi::AsyncWorker::OnWorkComplete and Napi::AsyncWorker::OnExecute methods are override-able.
• Removed erroneous finalizer cleanup in Napi::ThreadSafeFunction.
• Disabled caching in Napi::ArrayBuffer.
• Explicitly disallow assign and copy operator.
• Some minor corrections and improvements.

Documentation

• Updated documentation for Napi::Object.
• Updated documentation for Napi::Function.
• Updated documentation for Napi::ObjectWrap.
• Added documentation on how to add benchmark.
• Added documentation for Napi::AsyncProgressQueueWorker.
• Added suggestion about tags to use on NPM.
• Added reference to N-API badges.
• Some minor corrections all over the documentation.

TEST

• Updated test cases for Napi::Object.
• Updated test cases for Napi::Function.
• Updated test cases for Napi::ObjectWrap.
• Updated test cases for Napi::Env.
• Added test cases for Napi::AsyncProgressQueueWorker.
• Some minor corrections all over the test suite.

Commits

• [187318e37f] - doc: Removed references to Node.js lower than 10.x. (#709) (Nicola Del Gobbo)
• [9c9accfbbe] - src: add support for addon instance data (Gabriel Schulhof) #663
• [82a96502a4] - src: change guards to NAPI_VERSION > 5 (Gabriel Schulhof) #697
• [a64e8a5641] - ci: move travis from 13 to 14 (#707) (Gabriel Schulhof)
• [4de23c9d6b] - doc: fix support bigint64/biguint64 guards (Yulong Wang) #705
• [fedc8195e3] - doc: fix semicolon missing in async_worker.md (Azlan Mukhtar) #701
• [cdb662506c] - doc: fix typo in bigint.md (#700) (Kelvin)
• [e1a827ae29] - src: fix AsyncProgressQueueWorker compilation (#696) (Gabriel Schulhof) #696
• [2c3d5df463] - Merge pull request #692 from kelvinhammond/patch-1 (Nicola Del Gobbo)
• [623e876949] - Merge pull request #688 from NickNaso/badges (Nicola Del Gobbo)
• [6c97913d1f] - Fix minor typo in object_lifetime_management.md (Kelvin)
• [6b8dd47c55] - Added badge section to documentation. (NickNaso)
• [89e62a9154] - doc: recommend tags of addon helpers (legendecas) #683
• [ab018444ae] - src: implement AsyncProgressQueueWorker (legendecas) #585
• [d43da6ac2b] - doc: add @legendecas to active member list (legendecas)
• [cb498bbe7f] - doc: Add Napi::BigInt::New() overload for uint64_t (ikokostya)
• [baaaa8452c] - doc: link threadsafe function from JS function (legendecas)
• [7f56a78ff7] - objectwrap: remove wrap only on failure (Gabriel Schulhof)
• [4d816183da] - doc: fix example code (András Timár, Dr) #657
• [7ac6e21801] - gyp: fix gypfile name in index.js (Anna Henningsen) #658
• [46484202ca] - test: user data in function property descriptor (Kevin Eady) #652
• [0f8d730483] - doc: fix syntax error in example (András Timár, Dr) #650
• [4e885069f1] - src: call napi\_remove\_wrap() in ObjectWrap dtor (Anna Henningsen) #475
• [2fde5c3ca3] - test: update BigInt test for recent change in core (Michael Dawson) #649
• [e8935bd8d9] - test: add test for own properties on ObjectWrap (Guenter Sandner) #645
• [23ff7f0b24] - src: make OnWorkComplete and OnExecute override-able (legendecas) #589
• [86384f94d3] - objectwrap: gracefully handle constructor exceptions (Gabriel Schulhof)
• [9af69da01f] - remove N-API implementation, v6.x and v8.x support (Gabriel Schulhof) #643
• [920d544779] - benchmark: add templated version of Function (Gabriel Schulhof) #637
• [03759f7759] - ignore benchmark built archives (legendecas) #631
• [5eeabb0214] - tsfn: Remove erroneous finalizer cleanup (Kevin Eady) #636
• [9e0e0f31e4] - src: remove unnecessary forward declarations (Gabriel Schulhof) #633
• [79deefb6f3] - src: explicitly disallow assign and copy (legendecas) #590
• [af50ac281b] - error: do not replace pending exception (Gabriel Schulhof) #629
• [b72f1d6978] - Disable caching in ArrayBuffer (Tobias Nießen) #611
• [0e7483eb7b] - Fix code format in tests (Tobias Nießen) #617
• [6a0646356d] - add benchmarking framework (Gabriel Schulhof) #623
• [ffc71edd54] - Add Env::RunScript (Tobias Nießen) #616
• [a1b106066e] - src: add templated function factories (Gabriel Schulhof) #608
• [c584343217] - Add GetPropertyNames, HasOwnProperty, Delete (#615) (Tobias Nießen) #615
• [3acc4b32f5] - Fix std::string encoding (#619) (Tobias Nießen) #619
• [e71d0eadcc] - [doc] Fixed links to array documentation (#613) (Nicola Del Gobbo)
• [3dfb1f0591] - Change "WG" to "team" (Tobias Nießen)
• [ce91e14860] - objectwrap: add template methods (Dmitry Ashkadov) #604
• [cfa71b60f7] - object: add templated property descriptors (Gabriel Schulhof) #610
• [734725e971] - Correctly define copy assignment operators. (Rolf Timmermans)

2019-11-21 Version 2.0.0, @NickNaso

Notable changes:

API

• Added Napi::AsyncProgressWorker api.
• Added error checking on Napi::ThreadSafeFunction::GetContext.
• Added copy constructor to Napi::ThreadSafeFunction.
• Added Napi::ThreadSafeFunction::Ref and Napi::ThreadSafeFunction::Unref to Napi::ThreadSafeFunction.
• Added Napi::Object::AddFinalizer method.
• Use napi_add_finalizer() to attach data when building against N-API 5.
• Added Napi::Date api.
• Added Napi::ObjectWrap::Finalize method.

Documentation

• Added documentation for Napi::AsyncProgressWorker.
• Improve Napi::AsyncWorker documentation.
• Added documentation for Napi::Object::AddFinalizer method.
• Improved documentation for Napi::ThreadSafeFunction.
• Improved documentation about the usage of CMake as build tool.
• Some minor corrections all over the documentation.

TEST

• Added test cases for Napi::AsyncProgressWorker api.
• Added test cases for Napi::Date api.
• Added test cases for new features added to Napi::ThreadSafeFunction.

Commits

• [c881168d49] - tsfn: add error checking on GetContext (#583) (Kevin Eady) #583
• [24d75dd82f] - Merge pull request #588 from NickNaso/add-asyncprogress-worker-readme (Nicola Del Gobbo)
• [aa79e37b62] - Merge pull request #587 from timrach/patch-1 (Nicola Del Gobbo)
• [df75e08c2b] - tsfn: support direct calls to underlying napi_tsfn (Kevin Eady) #58
• [2298dfae58] - doc: Added AsyncProgressWorker to readme (NickNaso)
• [b3609d33b6] - Fix return type and declaration of setter callback (Tim Rach)
• [295e560f55] - test: improve guards for experimental features (legendecas)
• [2e71842f63] - tsfn: Implement copy constructor (Kevin Eady) #546
• [650562cab9] - src: implement AsyncProgressWorker (legendecas) #529
• [bdfd14101f] - src: attach data with napi_add_finalizer (Gabriel Schulhof) #577
• [9e955a802b] - doc: change node.js to Node.js per guideline (#579) (Tobias Nießen) #579
• [b42e21e3a9] - build: move node/6 to travis allowed failures and add node/13 (#573) (Gabriel Schulhof)
• [8d6132f609] - doc: improve AsyncWorker docs (#571) (legendecas) #571
• [bc8fc23627] - test: do not run TSFN tests on NAPI_VERSION < 4 (legendecas) #576
• [bcc1d58fc4] - implement Object::AddFinalizer (Gabriel Schulhof)
• [e9a4bcd52a] - doc: updates Make.js doc to current best practices (Jim Schlight) #558
• [b513d1aa7a] - doc: fix return type of ArrayBuffer::Data (Tobias Nießen) #552
• [34c11cf0a4] - src: disallow copying, double close of scopes (legendecas) #566
• [ce139a05e8] - src: make failure of closing scopes fatal (legendecas) #566
• [740c79823e] - src: add Env() to AsyncContext (Rolf Timmermans) #568
• [ea9ce1c801] - tsfn: add wrappers for Ref and Unref (Kevin Eady) #561
• [2e1769e1a3] - error: remove unnecessary if condition (legendecas) #562
• [828f223a87] - doc: fix spelling in ObjectWrap doc (#563) (Tobias Nießen) #563
• [dd9fa8a4a8] - doc: move Arunesh and Taylor to Emeritus (#540) (Michael Dawson) #540
• [cf8b8415df] - doc: add Kevin to the list of collaborators (#539) (Michael Dawson) #539
• [5d6aeae7b5] - build: enable travis for fast PR check (legendecas)
• [6192e705cd] - src: add napi_date (Mathias Küsel) #497
• [7b1ee96d52] - doc: update prebuild_tools.md (Nurbol Alpysbayev) #527
• [0b4f3a5b8c] - tsfn: fix crash on releasing tsfn (legendecas) #532
• [c3c8814d2f] - implement virutal ObjectWrap::Finalize (Michael Price) #515

2019-07-23 Version 1.7.1, @NickNaso

Notable changes:

API

• Fixed compilation problems that happen on Node.js with N-API version less than 4.

Commits

• [c20bcbd069] - Merge pull request #518 from NickNaso/master (Nicola Del Gobbo)
• [6720d57253] - Create the native threadsafe_function for test only for N-API greater than 3. (NickNaso)
• [37b6c185ad] - Fix compilation breakage on 1.7.0 (NickNaso)

2019-07-23 Version 1.7.0, @NickNaso

Notable changes:

API

• Added Napi::ThreadSafeFunction api.
• Added Napi::AsyncWorker::GetResult() method to Napi::AsyncWorker.
• Added Napi::AsyncWorker::Destroy()() method to Napi::AsyncWorker.
• Use full namespace on macros that create the errors.

Documentation

• Added documentation about contribution philosophy.
• Added documentation for Napi::ThreadSafeFunction.
• Some minor corrections all over the documentation.

TEST

• Added test case for bool operator.
• Fixed test case for Napi::ObjectWrap.

Commits

• [717c9ab163] - AsyncWorker: add GetResult() method (Kevin Eady) #512
• [d9d991bbc9] - doc: add ThreadSafeFunction to main README (#513) (Kevin Eady) #513
• [ac6000d0fd] - doc: fix minor typo (Yohei Kishimoto) #510
• [e9fa1eaa86] - doc: document ThreadSafeFunction (#494) (Kevin Eady) #494
• [cab3b1e2a2] - doc: ClassPropertyDescriptor example (Ross Weir) #507
• [c32d7dbdcf] - macros: create errors fully namespaced (Gabriel Schulhof) #506
• [0a90df2fcb] - Implement ThreadSafeFunction class (Jinho Bang)
• [1fb540eeb5] - Use curly brackets to include node_api.h (NickNaso) #493
• [b2b08122ea] - AsyncWorker: make callback optional (Kevin Eady) #489
• [a0cac77c82] - Added test for bool operator (NickNaso) #490
• [ab7d8fcc48] - src: fix objectwrap test case (Michael Dawson) #495
• [3b6b9eb88a] - AsyncWorker: introduce Destroy() method (Gabriel Schulhof) #488
• [f633fbd95d] - string.md: Document existing New(env, value, length) APIs (Tux3) #486
• [aaea55eda9] - Little fix on code example (Nicola Del Gobbo) #470
• [e1cf9a35a1] - Use Value::IsEmpty to check for empty value (NickNaso) #478
• [3ad5dfc7d9] - Fix link (Alba Mendez) #481
• [a3b4d99c45] - doc: Add contribution philosophy doc (Hitesh Kanwathirtha)
• [36863f087b] - doc: refer to TypedArray and ArrayBuffer from Array (Gabriel "|Nix|" Schulhof) #465