summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntoine du Hamel <duhamelantoine1995@gmail.com>2020-10-01 20:49:03 +0200
committerMyles Borins <mylesborins@github.com>2020-10-14 16:21:22 -0400
commit62755b6230530d1ec3981f2849473da65e6d2ace (patch)
treecec88f3d9d85a1759d898b0721cfe190bebb2b40
parent8cacca0f62e18fada33efb1c3559591021ed5e17 (diff)
downloadnode-new-62755b6230530d1ec3981f2849473da65e6d2ace.tar.gz
doc: harmonize changes list ordering
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/139 PR-URL: https://github.com/nodejs/node/pull/35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
-rw-r--r--doc/api/crypto.md6
-rw-r--r--doc/api/dgram.md18
-rw-r--r--doc/api/fs.md58
-rw-r--r--doc/api/http.md18
-rw-r--r--doc/api/http2.md8
-rw-r--r--doc/api/https.md6
-rw-r--r--doc/api/packages.md20
-rw-r--r--doc/api/process.md6
-rw-r--r--doc/api/stream.md12
-rw-r--r--doc/api/util.md20
-rw-r--r--doc/api/v8.md6
-rw-r--r--doc/api/vm.md16
-rw-r--r--doc/api/worker_threads.md10
13 files changed, 103 insertions, 101 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 6021cb8d5a..880d27ba1b 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -840,13 +840,13 @@ console.log(uncompressedKey === ecdh.getPublicKey('hex'));
<!-- YAML
added: v0.11.14
changes:
- - version: v6.0.0
- pr-url: https://github.com/nodejs/node/pull/5522
- description: The default `inputEncoding` changed from `binary` to `utf8`.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/16849
description: Changed error format to better support invalid public key
error.
+ - version: v6.0.0
+ pr-url: https://github.com/nodejs/node/pull/5522
+ description: The default `inputEncoding` changed from `binary` to `utf8`.
-->
* `otherPublicKey` {string | Buffer | TypedArray | DataView}
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
index 4b084b20ad..209c76ccdb 100644
--- a/doc/api/dgram.md
+++ b/doc/api/dgram.md
@@ -409,6 +409,9 @@ changes:
- version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/22413
description: The `msg` parameter can now be any `TypedArray` or `DataView`.
+ - version: v12.0.0
+ pr-url: https://github.com/nodejs/node/pull/26871
+ description: Added support for sending data on connected sockets.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/11985
description: The `msg` parameter can be an `Uint8Array` now.
@@ -423,9 +426,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/4374
description: The `msg` parameter can be an array now. Also, the `offset`
and `length` parameters are optional now.
- - version: v12.0.0
- pr-url: https://github.com/nodejs/node/pull/26871
- description: Added support for sending data on connected sockets.
-->
* `msg` {Buffer|TypedArray|DataView|string|Array} Message to be sent.
@@ -733,16 +733,16 @@ chained.
<!-- YAML
added: v0.11.13
changes:
- - version: v8.6.0
- pr-url: https://github.com/nodejs/node/pull/14560
- description: The `lookup` option is supported.
+ - version: v11.4.0
+ pr-url: https://github.com/nodejs/node/pull/23798
+ description: The `ipv6Only` option is supported.
- version: v8.7.0
pr-url: https://github.com/nodejs/node/pull/13623
description: The `recvBufferSize` and `sendBufferSize` options are
supported now.
- - version: v11.4.0
- pr-url: https://github.com/nodejs/node/pull/23798
- description: The `ipv6Only` option is supported.
+ - version: v8.6.0
+ pr-url: https://github.com/nodejs/node/pull/14560
+ description: The `lookup` option is supported.
-->
* `options` {Object} Available options are:
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 58b97be26c..86fef8cbd1 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -1919,12 +1919,12 @@ If `options` is a string, then it specifies the encoding.
## `fs.exists(path, callback)`
<!-- YAML
added: v0.0.2
+deprecated: v1.0.0
changes:
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using
`file:` protocol. Support is currently still *experimental*.
-deprecated: v1.0.0
-->
> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
@@ -2154,6 +2154,10 @@ Synchronous fdatasync(2). Returns `undefined`.
<!-- YAML
added: v0.1.95
changes:
+ - version: v10.5.0
+ pr-url: https://github.com/nodejs/node/pull/20220
+ description: Accepts an additional `options` object to specify whether
+ the numeric values returned should be bigint.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
@@ -2162,10 +2166,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- - version: v10.5.0
- pr-url: https://github.com/nodejs/node/pull/20220
- description: Accepts an additional `options` object to specify whether
- the numeric values returned should be bigint.
-->
* `fd` {integer}
@@ -2507,6 +2507,10 @@ Synchronous link(2). Returns `undefined`.
<!-- YAML
added: v0.1.30
changes:
+ - version: v10.5.0
+ pr-url: https://github.com/nodejs/node/pull/20220
+ description: Accepts an additional `options` object to specify whether
+ the numeric values returned should be bigint.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
@@ -2519,10 +2523,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- - version: v10.5.0
- pr-url: https://github.com/nodejs/node/pull/20220
- description: Accepts an additional `options` object to specify whether
- the numeric values returned should be bigint.
-->
* `path` {string|Buffer|URL}
@@ -2542,14 +2542,14 @@ not the file that it refers to.
<!-- YAML
added: v0.1.30
changes:
- - version: v7.6.0
- pr-url: https://github.com/nodejs/node/pull/10739
- description: The `path` parameter can be a WHATWG `URL` object using `file:`
- protocol. Support is currently still *experimental*.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
+ - version: v7.6.0
+ pr-url: https://github.com/nodejs/node/pull/10739
+ description: The `path` parameter can be a WHATWG `URL` object using `file:`
+ protocol. Support is currently still *experimental*.
-->
* `path` {string|Buffer|URL}
@@ -3632,6 +3632,10 @@ utility). Returns `undefined`.
<!-- YAML
added: v0.0.2
changes:
+ - version: v10.5.0
+ pr-url: https://github.com/nodejs/node/pull/20220
+ description: Accepts an additional `options` object to specify whether
+ the numeric values returned should be bigint.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
@@ -3644,10 +3648,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- - version: v10.5.0
- pr-url: https://github.com/nodejs/node/pull/20220
- description: Accepts an additional `options` object to specify whether
- the numeric values returned should be bigint.
-->
* `path` {string|Buffer|URL}
@@ -3745,14 +3745,14 @@ Stats {
<!-- YAML
added: v0.1.21
changes:
- - version: v7.6.0
- pr-url: https://github.com/nodejs/node/pull/10739
- description: The `path` parameter can be a WHATWG `URL` object using `file:`
- protocol. Support is currently still *experimental*.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
+ - version: v7.6.0
+ pr-url: https://github.com/nodejs/node/pull/10739
+ description: The `path` parameter can be a WHATWG `URL` object using `file:`
+ protocol. Support is currently still *experimental*.
-->
* `path` {string|Buffer|URL}
@@ -3767,15 +3767,15 @@ Synchronous stat(2).
<!-- YAML
added: v0.1.31
changes:
+ - version: v12.0.0
+ pr-url: https://github.com/nodejs/node/pull/23724
+ description: If the `type` argument is left undefined, Node will autodetect
+ `target` type and automatically select `dir` or `file`.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `target` and `path` parameters can be WHATWG `URL` objects
using `file:` protocol. Support is currently still
*experimental*.
- - version: v12.0.0
- pr-url: https://github.com/nodejs/node/pull/23724
- description: If the `type` argument is left undefined, Node will autodetect
- `target` type and automatically select `dir` or `file`.
-->
* `target` {string|Buffer|URL}
@@ -3815,15 +3815,15 @@ example/
<!-- YAML
added: v0.1.31
changes:
+ - version: v12.0.0
+ pr-url: https://github.com/nodejs/node/pull/23724
+ description: If the `type` argument is left undefined, Node will autodetect
+ `target` type and automatically select `dir` or `file`.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `target` and `path` parameters can be WHATWG `URL` objects
using `file:` protocol. Support is currently still
*experimental*.
- - version: v12.0.0
- pr-url: https://github.com/nodejs/node/pull/23724
- description: If the `type` argument is left undefined, Node will autodetect
- `target` type and automatically select `dir` or `file`.
-->
* `target` {string|Buffer|URL}
diff --git a/doc/api/http.md b/doc/api/http.md
index dd7267b5b6..97631cf5bf 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -1040,20 +1040,20 @@ not be emitted.
<!-- YAML
added: v0.1.94
changes:
- - version: v6.0.0
- pr-url: https://github.com/nodejs/node/pull/4557
- description: The default action of calling `.destroy()` on the `socket`
- will no longer take place if there are listeners attached
- for `'clientError'`.
+ - version: v12.0.0
+ pr-url: https://github.com/nodejs/node/pull/25605
+ description: The default behavior will return a 431 Request Header
+ Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
- version: v9.4.0
pr-url: https://github.com/nodejs/node/pull/17672
description: The `rawPacket` is the current buffer that just parsed. Adding
this buffer to the error object of `'clientError'` event is to
make it possible that developers can log the broken packet.
- - version: v12.0.0
- pr-url: https://github.com/nodejs/node/pull/25605
- description: The default behavior will return a 431 Request Header
- Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
+ - version: v6.0.0
+ pr-url: https://github.com/nodejs/node/pull/4557
+ description: The default action of calling `.destroy()` on the `socket`
+ will no longer take place if there are listeners attached
+ for `'clientError'`.
-->
* `exception` {Error}
diff --git a/doc/api/http2.md b/doc/api/http2.md
index 4a2bcb8ce9..9679ed23f6 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -2075,6 +2075,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
@@ -2083,10 +2087,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 050a204ef1..c11e103af1 100644
--- a/doc/api/https.md
+++ b/doc/api/https.md
@@ -13,13 +13,13 @@ separate module.
<!-- YAML
added: v0.4.5
changes:
+ - version: v5.3.0
+ pr-url: https://github.com/nodejs/node/pull/4252
+ description: support `0` `maxCachedSessions` to disable TLS session caching.
- version: v2.5.0
pr-url: https://github.com/nodejs/node/pull/2228
description: parameter `maxCachedSessions` added to `options` for TLS
sessions reuse.
- - version: v5.3.0
- pr-url: https://github.com/nodejs/node/pull/4252
- description: support `0` `maxCachedSessions` to disable TLS session caching.
-->
An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See
diff --git a/doc/api/packages.md b/doc/api/packages.md
index 5e2e582390..ffc6607711 100644
--- a/doc/api/packages.md
+++ b/doc/api/packages.md
@@ -882,24 +882,24 @@ as ES modules and `.cjs` files are always treated as CommonJS.
added: v12.7.0
changes:
- version:
- - v13.2.0
+ - 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/29978
- description: Implement conditional exports.
+ 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.7.0
+ - v13.2.0
- v12.16.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 452da15878..bd6662fe39 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -2498,12 +2498,12 @@ To get the version string without the prepended _v_, use
<!-- YAML
added: v0.2.0
changes:
- - version: v4.2.0
- pr-url: https://github.com/nodejs/node/pull/3102
- description: The `icu` property is now supported.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15785
description: The `v8` property now includes a Node.js specific suffix.
+ - version: v4.2.0
+ pr-url: https://github.com/nodejs/node/pull/3102
+ description: The `icu` property is now supported.
-->
* {Object}
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 9144c3debc..d4b0561029 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1645,15 +1645,15 @@ const cleanup = finished(rs, (err) => {
<!-- YAML
added: v10.0.0
changes:
- - version: v13.10.0
- pr-url: https://github.com/nodejs/node/pull/31223
- description: Add support for async generators.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/32158
description: The `pipeline(..., cb)` will wait for the `'close'` event
before invoking the callback. The implementation tries to
detect legacy streams and only apply this behavior to streams
which are expected to emit `'close'`.
+ - version: v13.10.0
+ pr-url: https://github.com/nodejs/node/pull/31223
+ description: Add support for async generators.
-->
* `streams` {Stream[]|Iterable[]|AsyncIterable[]|Function[]}
@@ -2201,15 +2201,15 @@ constructor and implement the [`readable._read()`][] method.
#### `new stream.Readable([options])`
<!-- YAML
changes:
+ - version: v14.0.0
+ pr-url: https://github.com/nodejs/node/pull/30623
+ description: Change `autoDestroy` option default to `true`.
- version:
- v11.2.0
- v10.16.0
pr-url: https://github.com/nodejs/node/pull/22795
description: Add `autoDestroy` option to automatically `destroy()` the
stream when it emits `'end'` or errors.
- - version: v14.0.0
- pr-url: https://github.com/nodejs/node/pull/30623
- description: Change `autoDestroy` option default to `true`.
-->
* `options` {Object}
diff --git a/doc/api/util.md b/doc/api/util.md
index adf200e28a..c36636db48 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
@@ -257,6 +253,10 @@ changes:
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.
- version: v11.0.0
@@ -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 54e0180607..891060606f 100644
--- a/doc/api/v8.md
+++ b/doc/api/v8.md
@@ -112,13 +112,13 @@ stream.pipe(process.stdout);
<!-- YAML
added: v1.0.0
changes:
+ - version: v7.5.0
+ pr-url: https://github.com/nodejs/node/pull/10186
+ description: Support values exceeding the 32-bit unsigned integer range.
- version: v7.2.0
pr-url: https://github.com/nodejs/node/pull/8610
description: Added `malloced_memory`, `peak_malloced_memory`,
and `does_zap_garbage`.
- - version: v7.5.0
- pr-url: https://github.com/nodejs/node/pull/10186
- description: Support values exceeding the 32-bit unsigned integer range.
-->
* Returns: {Object}
diff --git a/doc/api/vm.md b/doc/api/vm.md
index d6035e6b4f..c270e1f6b6 100644
--- a/doc/api/vm.md
+++ b/doc/api/vm.md
@@ -54,14 +54,14 @@ executed in specific contexts.
<!-- YAML
added: v0.3.1
changes:
- - version: v5.7.0
- pr-url: https://github.com/nodejs/node/pull/4777
- description: The `cachedData` and `produceCachedData` options are
- supported now.
- version: v10.6.0
pr-url: https://github.com/nodejs/node/pull/20300
description: The `produceCachedData` is deprecated in favour of
`script.createCachedData()`.
+ - version: v5.7.0
+ pr-url: https://github.com/nodejs/node/pull/4777
+ description: The `cachedData` and `produceCachedData` options are
+ supported now.
-->
* `code` {string} The JavaScript code to compile.
@@ -811,13 +811,15 @@ const vm = require('vm');
<!-- YAML
added: v10.10.0
changes:
- - version: v14.1.0
- pr-url: https://github.com/nodejs/node/pull/32985
- description: The `importModuleDynamically` option is now supported.
- version: v14.3.0
pr-url: https://github.com/nodejs/node/pull/33364
description: Removal of `importModuleDynamically` due to compatibility
issues.
+ - version:
+ - v14.1.0
+ - v13.14.0
+ pr-url: https://github.com/nodejs/node/pull/32985
+ description: The `importModuleDynamically` option is now supported.
-->
* `code` {string} The body of the function to compile.
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
index 025c2d9457..1bf76762fb 100644
--- a/doc/api/worker_threads.md
+++ b/doc/api/worker_threads.md
@@ -640,15 +640,15 @@ changes:
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