diff --git a/doc/api/assert.md b/doc/api/assert.md index 0f66f456b3fe9a..1478515c811608 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -15,10 +15,11 @@ added: v9.9.0 changes: - version: REPLACEME pr-url: https://github.com/nodejs/node/pull/34001 - description: Exposed as `require('assert/strict')` + description: Exposed as `require('assert/strict')`. - version: - v13.9.0 - v12.16.2 + pr-url: https://github.com/nodejs/node/pull/31635 description: Changed "strict mode" to "strict assertion mode" and "legacy mode" to "legacy assertion mode" to avoid confusion with the more usual meaning of "strict mode". @@ -329,17 +330,23 @@ changes: minor comparison adjustments to make the check less surprising. - version: v9.0.0 pr-url: https://github.com/nodejs/node/pull/15001 - description: The `Error` names and messages are now properly compared + description: The `Error` names and messages are now properly compared. - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/12142 - description: The `Set` and `Map` content is also compared - - version: v6.4.0, v4.7.1 + description: The `Set` and `Map` content is also compared. + - version: + - v6.4.0 + - v4.7.1 pr-url: https://github.com/nodejs/node/pull/8002 description: Typed array slices are handled correctly now. - - version: v6.1.0, v4.5.0 + - version: + - v6.1.0 + - v4.5.0 pr-url: https://github.com/nodejs/node/pull/6432 description: Objects with circular references can be used as inputs now. - - version: v5.10.1, v4.4.3 + - version: + - v5.10.1 + - v4.4.3 pr-url: https://github.com/nodejs/node/pull/5910 description: Handle non-`Uint8Array` typed arrays correctly. --> @@ -449,17 +456,21 @@ changes: comparison. - version: v8.5.0 pr-url: https://github.com/nodejs/node/pull/15001 - description: The `Error` names and messages are now properly compared + description: The `Error` names and messages are now properly compared. - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/12142 - description: The `Set` and `Map` content is also compared - - version: v6.4.0, v4.7.1 + description: The `Set` and `Map` content is also compared. + - version: + - v6.4.0 + - v4.7.1 pr-url: https://github.com/nodejs/node/pull/8002 description: Typed array slices are handled correctly now. - version: v6.1.0 pr-url: https://github.com/nodejs/node/pull/6432 description: Objects with circular references can be used as inputs now. - - version: v5.10.1, v4.4.3 + - version: + - v5.10.1 + - v4.4.3 pr-url: https://github.com/nodejs/node/pull/5910 description: Handle non-`Uint8Array` typed arrays correctly. --> @@ -681,7 +692,9 @@ assert.doesNotReject(Promise.reject(new TypeError('Wrong value'))) @@ -1068,17 +1087,21 @@ changes: comparison. - version: v9.0.0 pr-url: https://github.com/nodejs/node/pull/15001 - description: The `Error` names and messages are now properly compared + description: The `Error` names and messages are now properly compared. - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/12142 - description: The `Set` and `Map` content is also compared - - version: v6.4.0, v4.7.1 + description: The `Set` and `Map` content is also compared. + - version: + - v6.4.0 + - v4.7.1 pr-url: https://github.com/nodejs/node/pull/8002 description: Typed array slices are handled correctly now. - version: v6.1.0 pr-url: https://github.com/nodejs/node/pull/6432 description: Objects with circular references can be used as inputs now. - - version: v5.10.1, v4.4.3 + - version: + - v5.10.1 + - v4.4.3 pr-url: https://github.com/nodejs/node/pull/5910 description: Handle non-`Uint8Array` typed arrays correctly. --> @@ -1153,7 +1176,7 @@ added: v0.1.21 changes: - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/17003 - description: Used comparison changed from Strict Equality to `Object.is()` + description: Used comparison changed from Strict Equality to `Object.is()`. --> * `actual` {any} @@ -1332,7 +1355,7 @@ added: v0.1.21 changes: - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/17003 - description: Used comparison changed from Strict Equality to `Object.is()` + description: Used comparison changed from Strict Equality to `Object.is()`. --> * `actual` {any} diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index e3a48861b9a655..f54e82ee46b909 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -546,7 +546,7 @@ added: v8.1.0 changes: - version: v8.2.0 pr-url: https://github.com/nodejs/node/pull/13490 - description: Renamed from `currentId` + description: Renamed from `currentId`. --> * Returns: {number} The `asyncId` of the current execution context. Useful to diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 08be65e9796c95..75ff6ff8d426f6 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -776,10 +776,6 @@ This is the size (in bytes) of pre-allocated internal `Buffer` instances used for pooling. This value may be modified. ### `buf[index]` - * `index` {integer} @@ -1145,7 +1141,9 @@ changes: - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/10236 description: The `value` can now be a `Uint8Array`. - - version: v5.7.0, v4.4.0 + - version: + - v5.7.0 + - v4.4.0 pr-url: https://github.com/nodejs/node/pull/4803 description: When `encoding` is being passed, the `byteOffset` parameter is no longer required. @@ -2018,7 +2016,9 @@ console.log(buf.subarray(-5, -2).toString()); @@ -856,7 +858,9 @@ changes: - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/10653 description: The `input` option can now be a `Uint8Array`. - - version: v6.2.1, v4.5.0 + - version: + - v6.2.1 + - v4.5.0 pr-url: https://github.com/nodejs/node/pull/6939 description: The `encoding` option can now explicitly be set to `buffer`. - version: v5.7.0 diff --git a/doc/api/cli.md b/doc/api/cli.md index 7242c49351b978..2279aa4172709f 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -290,7 +290,7 @@ changes: - version: v13.6.0 pr-url: https://github.com/nodejs/node/pull/30980 description: changed from `--experimental-wasi-unstable-preview0` to - `--experimental-wasi-unstable-preview1` + `--experimental-wasi-unstable-preview1`. --> Enable experimental WebAssembly System Interface (WASI) support. @@ -694,7 +694,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: Changed from `--diagnostic-report-directory` to - `--report-directory` + `--report-directory`. --> Location at which the report will be generated. @@ -711,7 +711,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-filename` to - `--report-filename` + `--report-filename`. --> Name of the file to which the report will be written. @@ -729,7 +729,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-on-fatalerror` to - `--report-on-fatalerror` + `--report-on-fatalerror`. --> Enables the report to be triggered on fatal errors (internal errors within @@ -750,7 +750,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-on-signal` to - `--report-on-signal` + `--report-on-signal`. --> Enables report to be generated upon receiving the specified (or predefined) @@ -769,7 +769,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-signal` to - `--report-signal` + `--report-signal`. --> Sets or resets the signal for report generation (not supported on Windows). @@ -787,7 +787,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/27312 description: changed from `--diagnostic-report-uncaught-exception` to - `--report-uncaught-exception` + `--report-uncaught-exception`. --> Enables report to be generated on uncaught exceptions. Useful when inspecting diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 5b22fc278ae211..32e90ca030bbb5 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -514,7 +514,7 @@ added: v1.0.0 changes: - version: REPLACEME pr-url: https://github.com/nodejs/node/pull/35093 - decription: The buffer argument can be a string or ArrayBuffer and is + description: The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes. - version: v7.2.0 pr-url: https://github.com/nodejs/node/pull/9398 @@ -543,7 +543,7 @@ added: v1.0.0 changes: - version: REPLACEME pr-url: https://github.com/nodejs/node/pull/35093 - decription: The buffer argument can be a string or ArrayBuffer and is + description: The buffer argument can be a string or ArrayBuffer and is limited to no more than 2 ** 31 - 1 bytes. - version: v11.0.0 pr-url: https://github.com/nodejs/node/pull/17825 @@ -882,13 +882,13 @@ console.log(uncompressedKey === ecdh.getPublicKey('hex')); * `otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView} @@ -1295,14 +1295,14 @@ changes: description: Added support for `'dh'`. - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26960 - description: Added support for `'rsa-pss'` + description: Added support for `'rsa-pss'`. - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26786 description: This property now returns `undefined` for KeyObject instances of unrecognized type instead of aborting. - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26774 - description: Added support for `'x25519'` and `'x448'` + description: Added support for `'x25519'` and `'x448'`. - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26319 description: Added support for `'ed25519'` and `'ed448'`. diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 7d4dc57e5abd85..bc693fe561ce0b 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -47,8 +47,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/31164 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v1.6.0 @@ -84,10 +84,10 @@ The `_linklist` module is deprecated. Please use a userland alternative. changes: - version: v14.0.0 pr-url: https://github.com/nodejs/node/pull/31165 - description: End-of-Life + description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.11.15 @@ -107,11 +107,11 @@ changes: pr-url: https://github.com/nodejs/node/pull/17882 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - - version: 0.4.0 + - version: v0.4.0 commit: 9c7f89bf56abd37a796fea621ad2e47dd33d2b82 description: Documentation-only deprecation. --> @@ -167,8 +167,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/25279 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.11.14 @@ -232,7 +232,7 @@ to the `constants` property exposed by the relevant module. For instance, changes: - version: v14.0.0 pr-url: https://github.com/nodejs/node/pull/31166 - description: End-of-Life (for `digest === null`) + description: End-of-Life (for `digest === null`). - version: v11.0.0 pr-url: https://github.com/nodejs/node/pull/22861 description: Runtime deprecation (for `digest === null`). @@ -268,8 +268,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/21153 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.11.13 @@ -289,8 +289,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/21153 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.11.13 @@ -310,8 +310,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/15412 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.11.7 @@ -346,14 +346,14 @@ changes: - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/9683 description: End-of-Life. - - version: v6.0.0 - pr-url: https://github.com/nodejs/node/pull/4525 - description: Runtime deprecation. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. + - version: v6.0.0 + pr-url: https://github.com/nodejs/node/pull/4525 + description: Runtime deprecation. - version: v0.1.96 commit: c93e0aaf062081db3ec40ac45b3e2c979d5759d6 description: Documentation-only deprecation. @@ -370,14 +370,14 @@ changes: - version: v8.0.0 pr-url: https://github.com/nodejs/node/pull/9683 description: End-of-Life. - - version: v6.0.0 - pr-url: https://github.com/nodejs/node/pull/4525 - description: Runtime deprecation. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. + - version: v6.0.0 + pr-url: https://github.com/nodejs/node/pull/4525 + description: Runtime deprecation. - version: v0.1.96 commit: c93e0aaf062081db3ec40ac45b3e2c979d5759d6 description: Documentation-only deprecation. @@ -393,7 +393,7 @@ The [`fs.readSync()`][] legacy `String` interface is deprecated. Use the changes: - version: v14.0.0 pr-url: https://github.com/nodejs/node/pull/31167 - description: End-of-Life + description: End-of-Life. - version: v6.12.0 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. @@ -448,8 +448,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/26973 description: Removed functionality. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v1.8.1 @@ -469,8 +469,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/33647 description: Server.connections has been removed. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.9.7 @@ -490,8 +490,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/27127 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.7.12 @@ -527,8 +527,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/25280 description: End-of-Life. - version: - - v4.8.6 - v6.12.0 + - v4.8.6 pr-url: https://github.com/nodejs/node/pull/10116 description: A deprecation code has been assigned. - version: v0.6.0 @@ -560,8 +560,8 @@ The `REPLServer.prototype.convertToContext()` API has been removed. @@ -934,13 +934,13 @@ instead. @@ -953,13 +953,13 @@ The [`util.isBoolean()`][] API is deprecated. @@ -973,13 +973,13 @@ The [`util.isBuffer()`][] API is deprecated. Please use @@ -992,13 +992,13 @@ The [`util.isDate()`][] API is deprecated. @@ -1011,13 +1011,13 @@ The [`util.isError()`][] API is deprecated. @@ -1030,13 +1030,13 @@ The [`util.isFunction()`][] API is deprecated. @@ -1049,13 +1049,13 @@ The [`util.isNull()`][] API is deprecated. @@ -1068,13 +1068,13 @@ The [`util.isNullOrUndefined()`][] API is deprecated. @@ -1083,17 +1083,17 @@ Type: Documentation-only The [`util.isNumber()`][] API is deprecated. -### DEP0053 `util.isObject()` +### DEP0053: `util.isObject()` @@ -1106,13 +1106,13 @@ The [`util.isObject()`][] API is deprecated. @@ -1125,13 +1125,13 @@ The [`util.isPrimitive()`][] API is deprecated. @@ -1144,13 +1144,13 @@ The [`util.isRegExp()`][] API is deprecated. @@ -1163,13 +1163,13 @@ The [`util.isString()`][] API is deprecated. @@ -1182,13 +1182,13 @@ The [`util.isSymbol()`][] API is deprecated. @@ -1250,12 +1250,12 @@ alternative. ### DEP0062: `node --debug` Type: End-of-Life @@ -1697,12 +1697,12 @@ code modification is necessary if that is done. ### DEP0085: AsyncHooks sensitive API @@ -1716,12 +1716,12 @@ Use the `AsyncResource` API instead. See ### DEP0086: Remove `runInAsyncIdScope` @@ -1867,11 +1867,11 @@ should start using the `async_context` variant of `MakeCallback` or changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26530 - description: End-of-Life + description: End-of-Life. - version: - - v8.12.0 - - v9.6.0 - v10.0.0 + - v9.6.0 + - v8.12.0 pr-url: https://github.com/nodejs/node/pull/18632 description: Runtime deprecation. --> @@ -2081,12 +2081,12 @@ The `produceCachedData` option is deprecated. Use ### DEP0111: `process.binding()` Type: Documentation-only (supports [`--pending-deprecation`][]) @@ -2448,6 +2448,7 @@ an officially supported API. changes: - version: v13.0.0 pr-url: https://github.com/nodejs/node/pull/29061 + description: Runtime deprecation. --> Type: Runtime diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 16283862959a3c..b21ea069ba9be9 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -174,7 +174,8 @@ This method throws `EBADF` if called on an unbound socket. * `msg` {Buffer|TypedArray|DataView|string|Array} Message to be sent. @@ -734,16 +735,16 @@ chained. * `options` {Object} Available options are: diff --git a/doc/api/domain.md b/doc/api/domain.md index ccfbc258504e1a..c7aabd489bd27c 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -3,6 +3,7 @@ deprecated: v1.4.2 changes: - version: v8.8.0 + pr-url: https://github.com/nodejs/node/pull/15695 description: Any `Promise`s created in VM contexts no longer have a `.domain` property. Their handlers are still executed in the proper domain, however, and `Promise`s created in the main diff --git a/doc/api/events.md b/doc/api/events.md index 7ace75fa65ddbe..5de7e06840ef5e 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -291,7 +291,9 @@ myEmitter.emit('event'); > Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead. @@ -2158,6 +2158,10 @@ Synchronous fdatasync(2). Returns `undefined`. * `fd` {integer} @@ -2515,6 +2515,10 @@ Synchronous link(2). Returns `undefined`. * `path` {string|Buffer|URL} @@ -2550,14 +2550,14 @@ not the file that it refers to. * `path` {string|Buffer|URL} @@ -2938,7 +2938,7 @@ changes: - v12.17.0 pr-url: https://github.com/nodejs/node/pull/31402 description: Options object can be passed in - to make Buffer, offset, length and position optional + to make Buffer, offset, length and position optional. --> * `fd` {integer} * `options` {Object} @@ -3240,7 +3240,7 @@ changes: - v12.17.0 pr-url: https://github.com/nodejs/node/pull/32460 description: Options object can be passed in - to make offset, length and position optional + to make offset, length and position optional. --> * `fd` {integer} @@ -3656,6 +3656,10 @@ utility). Returns `undefined`. * `path` {string|Buffer|URL} @@ -3769,14 +3769,14 @@ Stats { * `path` {string|Buffer|URL} @@ -3791,15 +3791,15 @@ Synchronous stat(2). * `target` {string|Buffer|URL} @@ -3839,15 +3839,15 @@ example/ * `target` {string|Buffer|URL} @@ -4240,7 +4240,7 @@ changes: - version: v10.10.0 pr-url: https://github.com/nodejs/node/pull/22150 description: The `buffer` parameter can now be any `TypedArray` or a - `DataView` + `DataView`. - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/12562 description: The `callback` parameter is no longer optional. Not passing diff --git a/doc/api/http.md b/doc/api/http.md index 2eed99fe89dbbf..a63e0a0c1b2546 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1051,20 +1051,20 @@ not be emitted. * `exception` {Error} @@ -1803,7 +1803,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/25974 description: Return `this` from `writeHead()` to allow chaining with `end()`. - - version: v5.11.0, v4.4.5 + - version: + - v5.11.0 + - v4.4.5 pr-url: https://github.com/nodejs/node/pull/6291 description: A `RangeError` is thrown if `statusCode` is not a number in the range `[100, 999]`. @@ -2195,7 +2197,9 @@ changes: - version: v13.3.0 pr-url: https://github.com/nodejs/node/pull/30570 description: The `maxHeaderSize` option is supported now. - - version: v9.6.0, v8.12.0 + - version: + - v9.6.0 + - v8.12.0 pr-url: https://github.com/nodejs/node/pull/15752 description: The `options` argument is supported now. --> diff --git a/doc/api/http2.md b/doc/api/http2.md index b2e10c2638619d..86fcc8151b6902 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2087,6 +2087,10 @@ changes: pr-url: https://github.com/nodejs/node/pull/27782 description: The `options` parameter now supports `net.createServer()` options. + - version: v9.6.0 + pr-url: https://github.com/nodejs/node/pull/15752 + description: Added the `Http1IncomingMessage` and `Http1ServerResponse` + option. - version: v8.9.3 pr-url: https://github.com/nodejs/node/pull/17105 description: Added the `maxOutstandingPings` option with a default limit of @@ -2095,10 +2099,6 @@ changes: pr-url: https://github.com/nodejs/node/pull/16676 description: Added the `maxHeaderListPairs` option with a default limit of 128 header pairs. - - version: v9.6.0 - pr-url: https://github.com/nodejs/node/pull/15752 - description: Added the `Http1IncomingMessage` and `Http1ServerResponse` - option. --> * `options` {Object} diff --git a/doc/api/https.md b/doc/api/https.md index e76a7c9b6a71b7..d8906868a34f43 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -13,13 +13,13 @@ separate module. An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See diff --git a/doc/api/modules.md b/doc/api/modules.md index 3a46aca8eff4fc..9138826fd2f9ee 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -902,8 +902,8 @@ loading. > Stability: 0 - Deprecated: Please use [`require.main`][] and diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 7ee1fd2e94263d..fbf3ed87e5996e 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -3779,7 +3779,7 @@ if (status != napi_ok) return status; changes: - version: v14.12.0 pr-url: https://github.com/nodejs/node/pull/35214 - description: added `napi_default_method` and `napi_default_property` + description: added `napi_default_method` and `napi_default_property`. --> ```c @@ -5241,6 +5241,7 @@ added: v8.0.0 napiVersion: 1 changes: - version: v8.6.0 + pr-url: https://github.com/nodejs/node/pull/15189 description: Added `async_context` parameter. --> @@ -5605,8 +5606,8 @@ a specific `napi_env`. ### napi_get_uv_event_loop @@ -5820,13 +5821,12 @@ napiVersion: 4 changes: - version: v14.5.0 pr-url: https://github.com/nodejs/node/pull/33453 - description: > - Support for `napi_would_deadlock` has been reverted. + description: Support for `napi_would_deadlock` has been reverted. - version: v14.1.0 pr-url: https://github.com/nodejs/node/pull/32689 - description: > - Return `napi_would_deadlock` when called with `napi_tsfn_blocking` from - the main thread or a worker thread and the queue is full. + description: Return `napi_would_deadlock` when called with + `napi_tsfn_blocking` from the main thread or a worker thread + and the queue is full. --> ```c diff --git a/doc/api/os.md b/doc/api/os.md index 08a566a27b6e29..6f761877b23c5e 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -324,7 +324,7 @@ changes: - version: v2.0.0 pr-url: https://github.com/nodejs/node/pull/747 description: This function is now cross-platform consistent and no longer - returns a path with a trailing slash on any platform + returns a path with a trailing slash on any platform. --> * Returns: {string} diff --git a/doc/api/packages.md b/doc/api/packages.md index 5593a3c082f943..ffc66077118640 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -800,12 +800,12 @@ The following fields in `package.json` files are used in Node.js: ### `"name"` @@ -830,8 +830,8 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to added: v12.0.0 changes: - version: - - v12.17.0 - v13.2.0 + - v12.17.0 pr-url: https://github.com/nodejs/node/pull/29866 description: Unflag `--experimental-modules`. --> @@ -882,24 +882,24 @@ as ES modules and `.cjs` files are always treated as CommonJS. added: v12.7.0 changes: - version: - - v12.16.0 - - v13.2.0 - pr-url: https://github.com/nodejs/node/pull/29978 - description: Implement conditional exports. + - v14.13.0 + pr-url: https://github.com/nodejs/node/pull/34718 + description: Add support for `"exports"` patterns. - version: + - v13.7.0 - v12.16.0 + pr-url: https://github.com/nodejs/node/pull/31008 + description: Implement logical conditional exports ordering. + - version: - v13.7.0 + - v12.16.0 pr-url: https://github.com/nodejs/node/pull/31001 description: Remove the `--experimental-conditional-exports` option. - version: + - v13.2.0 - v12.16.0 - - v13.7.0 - pr-url: https://github.com/nodejs/node/pull/31008 - description: Implement logical conditional exports ordering. - - version: - - v14.13.0 - pr-url: https://github.com/nodejs/node/pull/34718 - description: Add support for `"exports"` patterns. + pr-url: https://github.com/nodejs/node/pull/29978 + description: Implement conditional exports. --> * Type: {Object} | {string} | {string[]} diff --git a/doc/api/process.md b/doc/api/process.md index ac6f0adcb09fb2..119a02aa3d6b87 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2450,10 +2450,9 @@ flag's behavior. * {Object} diff --git a/doc/api/querystring.md b/doc/api/querystring.md index 03ee78aad0a23d..34d7675a9c99cc 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -55,7 +55,9 @@ changes: - version: v6.0.0 pr-url: https://github.com/nodejs/node/pull/6055 description: The returned object no longer inherits from `Object.prototype`. - - version: v6.0.0, v4.2.4 + - version: + - v6.0.0 + - v4.2.4 pr-url: https://github.com/nodejs/node/pull/3807 description: The `eq` parameter may now have a length of more than `1`. --> diff --git a/doc/api/readline.md b/doc/api/readline.md index 2e82fdf91a1f10..d572eb4bb29f9b 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -471,7 +471,9 @@ changes: - version: v13.9.0 pr-url: https://github.com/nodejs/node/pull/31318 description: The `tabSize` option is supported now. - - version: v8.3.0, 6.11.4 + - version: + - v8.3.0 + - v6.11.4 pr-url: https://github.com/nodejs/node/pull/13497 description: Remove max limit of `crlfDelay` option. - version: v6.6.0 diff --git a/doc/api/stream.md b/doc/api/stream.md index f51fe0b6b3e797..ff6990edaa005e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1651,15 +1651,15 @@ const cleanup = finished(rs, (err) => { * `streams` {Stream[]|Iterable[]|AsyncIterable[]|Function[]} @@ -2215,15 +2215,15 @@ constructor and implement the [`readable._read()`][] method. #### `new stream.Readable([options])` * `options` {Object} diff --git a/doc/api/tls.md b/doc/api/tls.md index a8d44e9aacbab2..3e9bb42aeea7b0 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1374,7 +1374,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/11984 description: The `ALPNProtocols` option can be a `TypedArray` or `DataView` now. - - version: v5.3.0, v4.7.0 + - version: + - v5.3.0 + - v4.7.0 pr-url: https://github.com/nodejs/node/pull/4246 description: The `secureContext` option is supported now. - version: v5.0.0 diff --git a/doc/api/url.md b/doc/api/url.md index d2ba4f3b098fa1..f3a76a6c4569a8 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1286,7 +1286,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/8215 description: The `auth` fields are now kept intact when `from` and `to` refer to the same host. - - version: v6.5.0, v4.6.2 + - version: + - v6.5.0 + - v4.6.2 pr-url: https://github.com/nodejs/node/pull/8214 description: The `port` field is copied correctly now. - version: v6.0.0 diff --git a/doc/api/util.md b/doc/api/util.md index 48027fa5e9232f..2bbb45819426b9 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -241,10 +241,6 @@ changes: - version: v12.11.0 pr-url: https://github.com/nodejs/node/pull/29606 description: The `%c` specifier is ignored now. - - version: v11.4.0 - pr-url: https://github.com/nodejs/node/pull/23708 - description: The `%d`, `%f` and `%i` specifiers now support Symbols - properly. - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/23162 description: The `format` argument is now only taken as such if it actually @@ -256,6 +252,10 @@ changes: first argument. This change removes previously present quotes from strings that were being output when the first argument was not a string. + - version: v11.4.0 + pr-url: https://github.com/nodejs/node/pull/23708 + description: The `%d`, `%f` and `%i` specifiers now support Symbols + properly. - version: v11.4.0 pr-url: https://github.com/nodejs/node/pull/24806 description: The `%o` specifier's `depth` has default depth of 4 again. @@ -475,13 +475,13 @@ changes: pr-url: https://github.com/nodejs/node/pull/27109 description: The `compact` options default is changed to `3` and the `breakLength` options default is changed to `80`. - - version: v11.11.0 - pr-url: https://github.com/nodejs/node/pull/26269 - description: The `compact` option accepts numbers for a new output mode. - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/24971 description: Internal properties no longer appear in the context argument of a custom inspection function. + - version: v11.11.0 + pr-url: https://github.com/nodejs/node/pull/26269 + description: The `compact` option accepts numbers for a new output mode. - version: v11.7.0 pr-url: https://github.com/nodejs/node/pull/25006 description: ArrayBuffers now also show their binary contents. @@ -494,13 +494,13 @@ changes: - version: v11.0.0 pr-url: https://github.com/nodejs/node/pull/22846 description: The `depth` default changed to `20`. - - version: v10.12.0 - pr-url: https://github.com/nodejs/node/pull/22788 - description: The `sorted` option is supported now. - version: v11.0.0 pr-url: https://github.com/nodejs/node/pull/22756 description: The inspection output is now limited to about 128 MB. Data above that size will not be fully inspected. + - version: v10.12.0 + pr-url: https://github.com/nodejs/node/pull/22788 + description: The `sorted` option is supported now. - version: v10.6.0 pr-url: https://github.com/nodejs/node/pull/20725 description: Inspecting linked lists and similar objects is now possible diff --git a/doc/api/v8.md b/doc/api/v8.md index 54e01806079e0a..891060606f6388 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -112,13 +112,13 @@ stream.pipe(process.stdout); * Returns: {Object} diff --git a/doc/api/vm.md b/doc/api/vm.md index 4fb4ead6955b02..ce5ff95f72bccc 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -54,14 +54,14 @@ executed in specific contexts. * `code` {string} The JavaScript code to compile. @@ -813,14 +813,15 @@ const vm = require('vm'); * `code` {string} The body of the function to compile. diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 526ddb4057eea1..d361e5f5822839 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -652,16 +652,16 @@ changes: pr-url: https://github.com/nodejs/node/pull/31664 description: The `filename` parameter can be a WHATWG `URL` object using `file:` protocol. - - version: - - v13.2.0 - - v12.16.0 - pr-url: https://github.com/nodejs/node/pull/26628 - description: The `resourceLimits` option was introduced. - version: - v13.4.0 - v12.16.0 pr-url: https://github.com/nodejs/node/pull/30559 description: The `argv` option was introduced. + - version: + - v13.2.0 + - v12.16.0 + pr-url: https://github.com/nodejs/node/pull/26628 + description: The `resourceLimits` option was introduced. --> * `filename` {string|URL} The path to the Worker’s main script or module. Must