node-addon-api Changelog

2020-06-02 Version 1.7.2, @NickNaso

Notable changes:

API

Fix memory corruption vulnerability

Commmits

[801bd068f4] - napi: fix memory corruption vulnerability (Tobias Nießen )

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.

Commmits

[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.

Commmits

[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

2019-04-03 Version 1.6.3, @NickNaso

Notable changes:

API

Added SuppressDestruct method to Napi::AsyncWorker.
Added new build targets for debug.
Exposed macros that throw errors.
Fixed memory leaks caused by callback data when a napi error occurs.
Fixed missing void *data usage in Napi::PropertyDescriptors.

Documentation

Some minor corrections all over the documentation.

Commmits

[83b41c2fe4] - Document adding -fvisibility=hidden flag for macOS users (Nicola Del Gobbo) #460
[1ed7ad8769] - doc: correct return type of Int32Value to int32_t (Bill Gallafent) #459
[b0f6b601aa] - src: add AsyncWorker destruction suppression (Gabriel Schulhof) #407
[72b1975cff] - doc: fix links to the Property Descriptor docs (Ryuichi Okumura) #458
[fcfc612728] - build: new build targets for debug purposes (Jinho Bang) #186
[c629553cd7] - doc: minor doc corrections and clarifications (Bruce A. MacNaughton) #426
[7b87e0b999] - doc: update number.md (Bernardo Heynemann) #436
[fcf173d2a1] - src: expose macros that throw errors (Gabriel Schulhof) #448
[b409a2f987] - package: add npm search keywords (Sam Roberts) #452
[0bc7987806] - doc: fix references to Weak and Persistent (Jake Barnes) #428
[ad6f569f85] - doc: dix typo (Abhishek Kumar Singh) #435
[28df833a49] - Merge pull request #441 from jschlight/master (Jim Schlight)
[4921e74d83] - Rearranges names to be alphabetical (Jim Schlight)
[48220335b0] - Membership review update (Jim Schlight)
[44f0695533] - Merge pull request #394 from NickNaso/create_release (Nicola DelGobbo)
[fa49d68416] - doc: fix some Finalizer signatures (Philipp Renoth) #414
[020ac4a628] - src: make Object::GetPropertyNames() const (Philipp Renoth)#415
[91eaa6f4cb] - src: fix callbackData leaks on error napi status (Philipp Renoth) #417
[0b40275752] - src: fix noexcept control flow issues (Philipp Renoth) #420
[c1ff2936f9] - src: fix missing void*data usage in PropertyDescriptors (Luciano Martorella) #374

2018-11-29 Version 1.6.2, @NickNaso

Notable changes:

API

Fixed selection logic for version 6.x.

Commmits

[07a0fc4e95] - src: fix selection logic for 6.x (Michael Dawson) #402

2018-11-14 Version 1.6.1, @NickNaso

Notable changes:

Documentation

Updated links for examples to point to node-addon-examples repo.
Fixed typos on some parts of documentation.

API

Removed unused member on Napi::CallbackScope.
Enabled Napi::CallbackScope only with N-API v3.

Commmits

[e7cd292a74] - src: remove unused CallbackScope member (Gabriel Schulhof) #391
[d47399fe25] - src: guard CallbackScope with N-API v3 (Michael Dawson) #395
[29a0262ab9] - doc: fix typo (Dongjin Na) #385
[b6dc15b88d] - doc: make links point to node-addon-examples repo (Nicola Del Gobbo) #389

2018-11-02 Version 1.6.0, @NickNaso

Notable changes:

Documentation

Improved documentation about ABI stability.

API

Add Napi::CallbackScope class that help to have the equivalent of the scope associated with a callback in place when making certain N-API calls

TEST

Added tests for Napi::Array class.
Added tests for Napi::ArrayBuffer class.

Commmits

[8ce605c657] - build: avoid using package-lock.json (Jaeseok Yoon) #359
[fa3a6150b3] - src: use MakeCallback() -> Call() in AsyncWorker (Jinho Bang) #361
[2342415463] - test: create test objects in the stack instead of the heap (Dongjin Na) #371
[67b7db0a6f] - test: write tests for Array class (Jaeseok Yoon) #363
[729f6dc4ee] - test: add arraybuffer tests (Dongjin Na) #369
[405f3e5b5b] - src: implement CallbackScope class (Jinho Bang) #362
[015d95312f] - doc: fix Napi::Reference link (Gentilhomme) #365
[fd65078e3c] - README.md: link to new ABI stability guide (Gabriel Schulhof) #367
[ffebf9ba9a] - Updates for release 1.5.0 (NickNaso)

2018-10-03 Version 1.5.0, @NickNaso

Notable changes:

Documentation

Completed the documentation to cover all the API surface.
Numerous fixes to make documentation more consistent in all of its parts.

API

Add Napi::AsyncContext class to handle asynchronous operation.
Add Napi::BigInt class to work with BigInt type.
Add Napi::VersionManagement class to retrieve the versions of Node.js and N-API.
Fix potential memory leaks.
DataView feature is enabled by default
Add descriptor for Symbols
Add new methods on Napi::FunctionReference.
Add the possibility to retrieve the environment on Napi::Promise::Deferred

TOOL

Add tool to check if a native add-on is built using N-API

TEST

Start to increase the test coverage
Fix in the test suite to better handle the experimental features that are not yet backported in the previous Node.js version.

Commits

[2009c019af] - Merge pull request #292 from devsnek/feature/bigint (Gus Caplan)
[e44aca985e] - add bigint class (Gus Caplan)
[a3951ab973] - Add documentation for Env(). (Rolf Timmermans) #318
[a6f7a6ad51] - Add Env() to Promise::Deferred. (Rolf Timmermans)
[0097e96b92] - Fixed broken links for Symbol and String (NickNaso)
[b0ecd38d76] - Fix Code of conduct link properly (#323) (Jake Yoon) #323
[223474900f] - doc: update Version management (Dongjin Na) #360
[4f76262a10] - doc: some fix on Napi::Boolean documentation (NickNaso) #354
[78374f72d2] - doc: number documentation (NickNaso) #356
[51ffe453f8] - doc: doc cleanup (NickNaso) #353
[fc11c944b2] - doc: major doc cleanup (NickNaso) #335
[100d0a7cb2] - doc: first pass on objectwrap documentation (NickNaso) #321
[c7d54180ff] - doc: the Napi::ObjectWrap example does not compile (Arnaud Botella) #339
[7cdd78726a] - doc: added cpp highlight for string.md (Jaeseok Yoon) #329
[8ed29f547c] - doc: add blurb about ABI stability (Gabriel Schulhof) #326
[757eb1f5a3] - doc: add function and function reference doc (NickNaso) #299
[2885c18591] - doc: Create changelog for release 1.4.0 (Nicola Del Gobbo)
[917bd60baa] - src: remove TODOs by fixing memory leaks (Gabriel Schulhof) #343
[dfcb93945f] - src: implement AsyncContext class (Jinho Bang) #252
[211ed38d0d] - src: make 'nothing' target a static library (Gabriel Schulhof) #348
[97c4ab5cf2] - src: add Call and MakeCallback that accept cargs (NickNaso) #344
[b6e2d92c09] - src: enable DataView feature by default (Jinho) #331
[0a00e7c97b] - src: implement missing descriptor defs for symbols (Philipp Renoth) #280
[38e01b7e3b] - src: first pass on adding version management apis (NickNaso) #325
[79ee8381d2] - src: fix compile failure in test (Michael Dawson) #345
[4d92a6066f] - src: Add ObjectReference test case (Anisha Rohra) #212
[779560f397] - test: add operator overloading tests in Number (Your Name) #355
[73fed84ceb] - test: add ability to control experimental tests (Michael Dawson) #350
[14c69abd46] - test: write tests for Boolean class (Jaeseok Yoon) #328
[2ad47a83b1] - test: explicitly cast to uint32_t in test (Gabriel Schulhof) #341
[622ffaea76] - test: Tighten up compiler warnings (Mikhail Cheshkov) #315
[fd3c37b0f2] - tools: add tool to check for N-API modules (Gabriel Schulhof) #346

2018-07-19 Version 1.4.0, @NickNaso

Notable changes:

Documentation

Numerous additions to the documentation, filling out coverage of API surface

API

Add resource parameters to AsyncWorker constructor
Add memory management feature

Commits

[7dc5ac8bc3] - doc: update metadata for release (Nicola Del Gobbo)
[d68e86adb4] - doc: Added documentation for PropertyDescriptor (Anisha Rohra) #309
[968a5f2000] - doc: Add documentation for ObjectReference.md (Anisha Rohra) #307
[908cdc314c] - doc: add TypedArray and TypedArrayOf (Kyle Farnung) #305
[2ff776ffe3] - backport node::Persistent (Gabriel Schulhof) #300
[98161970c9] - Backport perf, crash and exception handling fixes (Gabriel Schulhof) #295
[dd1191e086] - test: fix asyncworker test so it runs on 6.x (Michael Dawson) #298
[11697fcecd] - doc: ArrayBuffer and Buffer documentation (Kyle Farnung) #256
[605aa2babf] - Add memory management feature (NickNaso) #286
[86be13a611] - doc: Fix HandleScope docs (Ben Berman) #287
[90f92c4dc0] - doc: Update broken links in README.md (Hitesh Kanwathirtha) #290
[c2a620dc11] - doc: Clarify positioning versus N-API (Michael Dawson) #288
[6cff890ee5] - doc: Fix typo in docs (Ben Berman) #284
[7394bfd154] - doc: Fix typo in docs (Ben Berman) #285
[12b2cdeed3] - fix test files (Kyle Farnung) #257
[9ab6607242] - doc: Update Doc Version Number (joshgarde) #277
[e029a076c6] - doc: First pass at basic Node Addon API docs (Hitesh Kanwathirtha) #268
[74ff79717e] - doc: fix link to async_worker.md (Michael Dawson)
[5a63f45eda] - doc: First step of error and async doc (NickNaso) #272
[9d38f61afb] - doc: New Promise and Reference docs (Jim Schlight) #243
[43ff9fa836] - doc: Updated Object documentation (Anisha Rohra) #254
[b197f7cc8b] - doc: minor typos (Nick Soggin) #248
[4b8918b352] - Add resource parameters to AsyncWorker constructor (Jinho Bang) #253
[1ecf7c19b6] - doc: fix wrong link in readme (miloas) #255
[a750ed1932] - release: updates to metadata for next release (Michael Dawson)

2018-05-08 Version 1.3.0, @mhdawson

Notable changes:

Documentation

Added documentation for Scopes
Added documentation for migration from NAN
Update documentation to better explain the use of NODE_ADDON_API

API

Implement data manipulation methods for dataview
Use built-in N-API on Node.js >= 6.14.2
Value
Added IsExternal()
IsObject() allow functions
String
Fixed initialization of std::string to nullptr

Tests

Fix test failures on linuxOne and AIX
Added basic tests for Scopes
Fix MSVC warning C4244 in tests

Commits

[386c2aeb74] - test: remove dep on later C++ feature (Michael Dawson) https://github.com/nodejs/node-addon-api/pull/267
[10697734da] - Use built-in N-API on Node.js >= 6.14.2 (Gabriel Schulhof)
[75086da273] - test: add basic tests and doc for scopes (Michael Dawson) https://github.com/nodejs/node-addon-api/pull/250
[341dbd25d5] - doc: update blurb explaining NODE_ADDON_API (Gabriel Schulhof) https://github.com/nodejs/node-addon-api/pull/251
[cf6c93e4ee] - don't try to escape null (Michael Dawson) https://github.com/nodejs/node-addon-api/pull/245
[15e4b35fc2] - test: fix MSVC warning C4244 in tests (Kyle Farnung) https://github.com/nodejs/node-addon-api/pull/236
[7f3ca03b8e] - Create a doc for migration (Sampson Gao) https://github.com/nodejs/node-addon-api/pull/118
[0a2177debe] - Fix test failures on linuxOne and AIX (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/232
[d567f4b6b5] - Added Napi::Value::IsExternal() (Eric Bickle) https://github.com/nodejs/node-addon-api/pull/227
[1b0f0e004a] - Update node-gyp.md (Michele Campus) https://github.com/nodejs/node-addon-api/pull/226
[faf19c4f7a] - Fixed initialization of std::string to nullptr (Eric Bickle) https://github.com/nodejs/node-addon-api/pull/228
[9c4d321b57] - Implement data manipulation methods for dataview (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/218
[5a39fdca6f] - n-api: throw RangeError napi_create_typedarray() (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/216
[1376377202] - Make IsObject() allow functions (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/217
[673b59d319] - src: Initial implementation of DataView class (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/205
[0a899bf1c5] - doc: update indication of latest version (Michael Dawson) https://github.com/nodejs/node-addon-api/pull/211
[17c74e5a5e] - n-api: RangeError in napi_create_dataview() (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/214
[4058a29989] - n-api: fix memory leak in napi_async_destroy() (Jinho Bang) https://github.com/nodejs/node-addon-api/pull/213