Skip to content

Commit 081cdc2

Browse files
committed
Prepare release 3.0.0.
1 parent 187318e commit 081cdc2

File tree

2 files changed

+129
-7
lines changed

2 files changed

+129
-7
lines changed

CHANGELOG.md

+100-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,99 @@
11
# node-addon-api Changelog
22

3+
## 2020-04-30 Version 3.0.0, @NickNaso
4+
5+
### Notable changes:
6+
7+
#### API
8+
9+
- `Napi::Object` added templated property descriptors.
10+
- `Napi::ObjectWrap` added templated methods.
11+
- `Napi::ObjectWrap` the wrap is removed only on failure.
12+
- `Napi::ObjectWrap` the constructor's exceptions are gracefully handled.
13+
- `Napi::Function` added templated factory functions.
14+
- Added `Env::RunScript` method to run JavaScript code contained in a string.
15+
- Added templated version of `Napi::Function`.
16+
- Added benchmarking framework.
17+
- Added support for natove addon instance data.
18+
- Added `Napi::AsyncProgressQueueWorker` api.
19+
- Changed the guards to `NAPI_VERSION > 5`.
20+
- Removed N-API implementation (v6.x and v8.x support).
21+
- `Napi::AsyncWorker::OnWorkComplete` and `Napi::AsyncWorker::OnExecute` methods
22+
are override-able.
23+
- Removed erroneous finalizer cleanup in `Napi::ThreadSafeFunction`.
24+
- Disabled cahcing in `Napi::ArrayBuffer`.
25+
- Explicitly disallow assign and copy operator.
26+
- Some minor corrections and improvements.
27+
28+
#### Documentation
29+
30+
- Updated documentation for `Napi::Object`.
31+
- Updated documentation for `Napi::Function`.
32+
- Updated documentation for `Napi::ObjectWrap`.
33+
- Added documentation on how to add benchmark.
34+
- Added documentation for `Napi::AsyncProgressQueueWorker`.
35+
- Added suggestion about tags to use on NPM.
36+
- Added reference to N-API badges.
37+
- Some minor corrections all over the documentation.
38+
39+
#### TEST
40+
41+
- Updated test cases for `Napi::Object`.
42+
- Updated test cases for `Napi::Function`.
43+
- Updated test cases for `Napi::ObjectWrap`.
44+
- Updated test cases for `Napi::Env`.
45+
- Added test cases for `Napi::AsyncProgressQueueWorker`.
46+
- Some minor corrections all over the test suite.
47+
48+
### Commits
49+
50+
* [[`187318e37f`](https://github.com/nodejs/node-addon-api/commit/187318e37f)] - **doc**: Removed references to Node.js lower than 10.x. (#709) (Nicola Del Gobbo)
51+
* [[`9c9accfbbe`](https://github.com/nodejs/node-addon-api/commit/9c9accfbbe)] - **src**: add support for addon instance data (Gabriel Schulhof) [#663](https://github.com/nodejs/node-addon-api/pull/663)
52+
* [[`82a96502a4`](https://github.com/nodejs/node-addon-api/commit/82a96502a4)] - **src**: change guards to NAPI\_VERSION \> 5 (Gabriel Schulhof) [#697](https://github.com/nodejs/node-addon-api/pull/697)
53+
* [[`a64e8a5641`](https://github.com/nodejs/node-addon-api/commit/a64e8a5641)] - **ci**: move travis from 13 to 14 (#707) (Gabriel Schulhof)
54+
* [[`4de23c9d6b`](https://github.com/nodejs/node-addon-api/commit/4de23c9d6b)] - **doc**: fix support bigint64/biguint64 guards (Yulong Wang) [#705](https://github.com/nodejs/node-addon-api/pull/705)
55+
* [[`fedc8195e3`](https://github.com/nodejs/node-addon-api/commit/fedc8195e3)] - **doc**: fix semicolon missing in async\_worker.md (Azlan Mukhtar) [#701](https://github.com/nodejs/node-addon-api/pull/701)
56+
* [[`cdb662506c`](https://github.com/nodejs/node-addon-api/commit/cdb662506c)] - **doc**: fix typo in bigint.md (#700) (Kelvin)
57+
* [[`e1a827ae29`](https://github.com/nodejs/node-addon-api/commit/e1a827ae29)] - **src**: fix AsyncProgressQueueWorker compilation (#696) (Gabriel Schulhof) [#696](https://github.com/nodejs/node-addon-api/pull/696)
58+
* [[`2c3d5df463`](https://github.com/nodejs/node-addon-api/commit/2c3d5df463)] - Merge pull request #692 from kelvinhammond/patch-1 (Nicola Del Gobbo)
59+
* [[`623e876949`](https://github.com/nodejs/node-addon-api/commit/623e876949)] - Merge pull request #688 from NickNaso/badges (Nicola Del Gobbo)
60+
* [[`6c97913d1f`](https://github.com/nodejs/node-addon-api/commit/6c97913d1f)] - Fix minor typo in object\_lifetime\_management.md (Kelvin)
61+
* [[`6b8dd47c55`](https://github.com/nodejs/node-addon-api/commit/6b8dd47c55)] - Added badge section to documentation. (NickNaso)
62+
* [[`89e62a9154`](https://github.com/nodejs/node-addon-api/commit/89e62a9154)] - **doc**: recommend tags of addon helpers (legendecas) [#683](https://github.com/nodejs/node-addon-api/pull/683)
63+
* [[`ab018444ae`](https://github.com/nodejs/node-addon-api/commit/ab018444ae)] - **src**: implement AsyncProgressQueueWorker (legendecas) [#585](https://github.com/nodejs/node-addon-api/pull/585)
64+
* [[`d43da6ac2b`](https://github.com/nodejs/node-addon-api/commit/d43da6ac2b)] - **doc**: add @legendecas to active member list (legendecas)
65+
* [[`cb498bbe7f`](https://github.com/nodejs/node-addon-api/commit/cb498bbe7f)] - **doc**: Add Napi::BigInt::New() overload for uint64\_t (ikokostya)
66+
* [[`baaaa8452c`](https://github.com/nodejs/node-addon-api/commit/baaaa8452c)] - **doc**: link threadsafe function from JS function (legendecas)
67+
* [[`7f56a78ff7`](https://github.com/nodejs/node-addon-api/commit/7f56a78ff7)] - **objectwrap**: remove wrap only on failure (Gabriel Schulhof)
68+
* [[`4d816183da`](https://github.com/nodejs/node-addon-api/commit/4d816183da)] - **doc**: fix example code (András Timár, Dr) [#657](https://github.com/nodejs/node-addon-api/pull/657)
69+
* [[`7ac6e21801`](https://github.com/nodejs/node-addon-api/commit/7ac6e21801)] - **gyp**: fix gypfile name in index.js (Anna Henningsen) [#658](https://github.com/nodejs/node-addon-api/pull/658)
70+
* [[`46484202ca`](https://github.com/nodejs/node-addon-api/commit/46484202ca)] - **test**: user data in function property descriptor (Kevin Eady) [#652](https://github.com/nodejs/node-addon-api/pull/652)
71+
* [[`0f8d730483`](https://github.com/nodejs/node-addon-api/commit/0f8d730483)] - **doc**: fix syntax error in example (András Timár, Dr) [#650](https://github.com/nodejs/node-addon-api/pull/650)
72+
* [[`4e885069f1`](https://github.com/nodejs/node-addon-api/commit/4e885069f1)] - **src**: call `napi\_remove\_wrap()` in `ObjectWrap` dtor (Anna Henningsen) [#475](https://github.com/nodejs/node-addon-api/pull/475)
73+
* [[`2fde5c3ca3`](https://github.com/nodejs/node-addon-api/commit/2fde5c3ca3)] - **test**: update BigInt test for recent change in core (Michael Dawson) [#649](https://github.com/nodejs/node-addon-api/pull/649)
74+
* [[`e8935bd8d9`](https://github.com/nodejs/node-addon-api/commit/e8935bd8d9)] - **test**: add test for own properties on ObjectWrap (Guenter Sandner) [#645](https://github.com/nodejs/node-addon-api/pull/645)
75+
* [[`23ff7f0b24`](https://github.com/nodejs/node-addon-api/commit/23ff7f0b24)] - **src**: make OnWorkComplete and OnExecute override-able (legendecas) [#589](https://github.com/nodejs/node-addon-api/pull/589)
76+
* [[`86384f94d3`](https://github.com/nodejs/node-addon-api/commit/86384f94d3)] - **objectwrap**: gracefully handle constructor exceptions (Gabriel Schulhof)
77+
* [[`9af69da01f`](https://github.com/nodejs/node-addon-api/commit/9af69da01f)] - remove N-API implementation, v6.x and v8.x support (Gabriel Schulhof) [#643](https://github.com/nodejs/node-addon-api/pull/643)
78+
* [[`920d544779`](https://github.com/nodejs/node-addon-api/commit/920d544779)] - **benchmark**: add templated version of Function (Gabriel Schulhof) [#637](https://github.com/nodejs/node-addon-api/pull/637)
79+
* [[`03759f7759`](https://github.com/nodejs/node-addon-api/commit/03759f7759)] - ignore benchmark built archives (legendecas) [#631](https://github.com/nodejs/node-addon-api/pull/631)
80+
* [[`5eeabb0214`](https://github.com/nodejs/node-addon-api/commit/5eeabb0214)] - **tsfn**: Remove erroneous finalizer cleanup (Kevin Eady) [#636](https://github.com/nodejs/node-addon-api/pull/636)
81+
* [[`9e0e0f31e4`](https://github.com/nodejs/node-addon-api/commit/9e0e0f31e4)] - **src**: remove unnecessary forward declarations (Gabriel Schulhof) [#633](https://github.com/nodejs/node-addon-api/pull/633)
82+
* [[`79deefb6f3`](https://github.com/nodejs/node-addon-api/commit/79deefb6f3)] - **src**: explicitly disallow assign and copy (legendecas) [#590](https://github.com/nodejs/node-addon-api/pull/590)
83+
* [[`af50ac281b`](https://github.com/nodejs/node-addon-api/commit/af50ac281b)] - **error**: do not replace pending exception (Gabriel Schulhof) [#629](https://github.com/nodejs/node-addon-api/pull/629)
84+
* [[`b72f1d6978`](https://github.com/nodejs/node-addon-api/commit/b72f1d6978)] - Disable caching in ArrayBuffer (Tobias Nießen) [#611](https://github.com/nodejs/node-addon-api/pull/611)
85+
* [[`0e7483eb7b`](https://github.com/nodejs/node-addon-api/commit/0e7483eb7b)] - Fix code format in tests (Tobias Nießen) [#617](https://github.com/nodejs/node-addon-api/pull/617)
86+
* [[`6a0646356d`](https://github.com/nodejs/node-addon-api/commit/6a0646356d)] - add benchmarking framework (Gabriel Schulhof) [#623](https://github.com/nodejs/node-addon-api/pull/623)
87+
* [[`ffc71edd54`](https://github.com/nodejs/node-addon-api/commit/ffc71edd54)] - Add Env::RunScript (Tobias Nießen) [#616](https://github.com/nodejs/node-addon-api/pull/616)
88+
* [[`a1b106066e`](https://github.com/nodejs/node-addon-api/commit/a1b106066e)] - **src**: add templated function factories (Gabriel Schulhof) [#608](https://github.com/nodejs/node-addon-api/pull/608)
89+
* [[`c584343217`](https://github.com/nodejs/node-addon-api/commit/c584343217)] - Add GetPropertyNames, HasOwnProperty, Delete (#615) (Tobias Nießen) [#615](https://github.com/nodejs/node-addon-api/pull/615)
90+
* [[`3acc4b32f5`](https://github.com/nodejs/node-addon-api/commit/3acc4b32f5)] - Fix std::string encoding (#619) (Tobias Nießen) [#619](https://github.com/nodejs/node-addon-api/pull/619)
91+
* [[`e71d0eadcc`](https://github.com/nodejs/node-addon-api/commit/e71d0eadcc)] - \[doc\] Fixed links to array documentation (#613) (Nicola Del Gobbo)
92+
* [[`3dfb1f0591`](https://github.com/nodejs/node-addon-api/commit/3dfb1f0591)] - Change "WG" to "team" (Tobias Nießen)
93+
* [[`ce91e14860`](https://github.com/nodejs/node-addon-api/commit/ce91e14860)] - **objectwrap**: add template methods (Dmitry Ashkadov) [#604](https://github.com/nodejs/node-addon-api/pull/604)
94+
* [[`cfa71b60f7`](https://github.com/nodejs/node-addon-api/commit/cfa71b60f7)] - **object**: add templated property descriptors (Gabriel Schulhof) [#610](https://github.com/nodejs/node-addon-api/pull/610)
95+
* [[`734725e971`](https://github.com/nodejs/node-addon-api/commit/734725e971)] - Correctly define copy assignment operators. (Rolf Timmermans)
96+
397
## 2019-11-21 Version 2.0.0, @NickNaso
498

599
### Notable changes:
@@ -30,7 +124,7 @@
30124
- Added test cases for `Napi::Date` api.
31125
- Added test cases for new features added to `Napi::ThreadSafeFunction`.
32126

33-
### Commmits
127+
### Commits
34128

35129
* [[`c881168d49`](https://github.com/nodejs/node-addon-api/commit/c881168d49)] - **tsfn**: add error checking on GetContext (#583) (Kevin Eady) [#583](https://github.com/nodejs/node-addon-api/pull/583)
36130
* [[`24d75dd82f`](https://github.com/nodejs/node-addon-api/commit/24d75dd82f)] - Merge pull request #588 from NickNaso/add-asyncprogress-worker-readme (Nicola Del Gobbo)
@@ -71,7 +165,7 @@
71165

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

74-
### Commmits
168+
### Commits
75169

76170
* [[`c20bcbd069`](https://github.com/nodejs/node-addon-api/commit/c20bcbd069)] - Merge pull request #518 from NickNaso/master (Nicola Del Gobbo)
77171
* [[`6720d57253`](https://github.com/nodejs/node-addon-api/commit/6720d57253)] - Create the native threadsafe\_function for test only for N-API greater than 3. (NickNaso)
@@ -99,7 +193,7 @@
99193
- Added test case for bool operator.
100194
- Fixed test case for `Napi::ObjectWrap`.
101195

102-
### Commmits
196+
### Commits
103197

104198
* [[`717c9ab163`](https://github.com/nodejs/node-addon-api/commit/717c9ab163)] - **AsyncWorker**: add GetResult() method (Kevin Eady) [#512](https://github.com/nodejs/node-addon-api/pull/512)
105199
* [[`d9d991bbc9`](https://github.com/nodejs/node-addon-api/commit/d9d991bbc9)] - **doc**: add ThreadSafeFunction to main README (#513) (Kevin Eady) [#513](https://github.com/nodejs/node-addon-api/pull/513)
@@ -136,7 +230,7 @@
136230

137231
- Some minor corrections all over the documentation.
138232

139-
### Commmits
233+
### Commits
140234

141235
* [[`83b41c2fe4`](https://github.com/nodejs/node-addon-api/commit/83b41c2fe4)] - Document adding -fvisibility=hidden flag for macOS users (Nicola Del Gobbo) [#460](https://github.com/nodejs/node-addon-api/pull/460)
142236
* [[`1ed7ad8769`](https://github.com/nodejs/node-addon-api/commit/1ed7ad8769)] - **doc**: correct return type of Int32Value to int32\_t (Bill Gallafent) [#459](https://github.com/nodejs/node-addon-api/pull/459)
@@ -185,7 +279,7 @@
185279
- Removed unused member on `Napi::CallbackScope`.
186280
- Enabled `Napi::CallbackScope` only with N-API v3.
187281

188-
### Commmits
282+
### Commits
189283

190284
* [[`e7cd292a74`](https://github.com/nodejs/node-addon-api/commit/e7cd292a74)] - **src**: remove unused CallbackScope member (Gabriel Schulhof) [#391](https://github.com/nodejs/node-addon-api/pull/391)
191285
* [[`d47399fe25`](https://github.com/nodejs/node-addon-api/commit/d47399fe25)] - **src**: guard CallbackScope with N-API v3 (Michael Dawson) [#395](https://github.com/nodejs/node-addon-api/pull/395)
@@ -210,7 +304,7 @@ associated with a callback in place when making certain N-API calls
210304
- Added tests for `Napi::Array` class.
211305
- Added tests for `Napi::ArrayBuffer` class.
212306

213-
### Commmits
307+
### Commits
214308

215309
* [[`8ce605c657`](https://github.com/nodejs/node-addon-api/commit/8ce605c657)] - **build**: avoid using package-lock.json (Jaeseok Yoon) [#359](https://github.com/nodejs/node-addon-api/pull/359)
216310
* [[`fa3a6150b3`](https://github.com/nodejs/node-addon-api/commit/fa3a6150b3)] - **src**: use MakeCallback() -\> Call() in AsyncWorker (Jinho Bang) [#361](https://github.com/nodejs/node-addon-api/pull/361)

package.json

+29-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
"name": "Alba Mendez",
1212
"url": "https://github.com/jmendeth"
1313
},
14+
{
15+
"name": "András Timár, Dr",
16+
"url": "https://github.com/timarandras"
17+
},
1418
{
1519
"name": "Andrew Petersen",
1620
"url": "https://github.com/kirbysayshi"
@@ -31,6 +35,10 @@
3135
"name": "Arunesh Chandra",
3236
"url": "https://github.com/aruneshchandra"
3337
},
38+
{
39+
"name": "Azlan Mukhtar",
40+
"url": "https://github.com/azlan"
41+
},
3442
{
3543
"name": "Ben Berman",
3644
"url": "https://github.com/rivertam"
@@ -55,6 +63,10 @@
5563
"name": "David Halls",
5664
"url": "https://github.com/davedoesdev"
5765
},
66+
{
67+
"name": "Dmitry Ashkadov",
68+
"url": "https://github.com/dmitryash"
69+
},
5870
{
5971
"name": "Dongjin Na",
6072
"url": "https://github.com/nadongguri"
@@ -67,6 +79,10 @@
6779
"name": "Gabriel Schulhof",
6880
"url": "https://github.com/gabrielschulhof"
6981
},
82+
{
83+
"name": "Guenter Sandner",
84+
"url": "https://github.com/gms1"
85+
},
7086
{
7187
"name": "Gus Caplan",
7288
"url": "https://github.com/devsnek"
@@ -75,6 +91,10 @@
7591
"name": "Hitesh Kanwathirtha",
7692
"url": "https://github.com/digitalinfinity"
7793
},
94+
{
95+
"name": "ikokostya",
96+
"url": "https://github.com/ikokostya"
97+
},
7898
{
7999
"name": "Jake Barnes",
80100
"url": "https://github.com/DuBistKomisch"
@@ -99,6 +119,10 @@
99119
"name": "joshgarde",
100120
"url": "https://github.com/joshgarde"
101121
},
122+
{
123+
"name": "Kelvin",
124+
"url": "https://github.com/kelvinhammond"
125+
},
102126
{
103127
"name": "Kevin Eady",
104128
"url": "https://github.com/KevinEady"
@@ -202,6 +226,10 @@
202226
{
203227
"name": "Yohei Kishimoto",
204228
"url": "https://github.com/morokosi"
229+
},
230+
{
231+
"name": "Yulong Wang",
232+
"url": "https://github.com/fs-eire"
205233
}
206234
],
207235
"dependencies": {},
@@ -244,5 +272,5 @@
244272
"dev:incremental": "node test",
245273
"doc": "doxygen doc/Doxyfile"
246274
},
247-
"version": "2.0.0"
275+
"version": "3.0.0"
248276
}

0 commit comments

Comments
 (0)