Skip to content

Commit 62755b6

Browse files
aduh95MylesBorins
authored andcommitted
doc: harmonize changes list ordering
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ujjwal Sharma <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Khaidi Chu <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 8cacca0 commit 62755b6

13 files changed

+103
-101
lines changed

doc/api/crypto.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -840,13 +840,13 @@ console.log(uncompressedKey === ecdh.getPublicKey('hex'));
840840
<!-- YAML
841841
added: v0.11.14
842842
changes:
843-
- version: v6.0.0
844-
pr-url: https://github.com/nodejs/node/pull/5522
845-
description: The default `inputEncoding` changed from `binary` to `utf8`.
846843
- version: v10.0.0
847844
pr-url: https://github.com/nodejs/node/pull/16849
848845
description: Changed error format to better support invalid public key
849846
error.
847+
- version: v6.0.0
848+
pr-url: https://github.com/nodejs/node/pull/5522
849+
description: The default `inputEncoding` changed from `binary` to `utf8`.
850850
-->
851851

852852
* `otherPublicKey` {string | Buffer | TypedArray | DataView}

doc/api/dgram.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,9 @@ changes:
409409
- version: v14.5.0
410410
pr-url: https://github.com/nodejs/node/pull/22413
411411
description: The `msg` parameter can now be any `TypedArray` or `DataView`.
412+
- version: v12.0.0
413+
pr-url: https://github.com/nodejs/node/pull/26871
414+
description: Added support for sending data on connected sockets.
412415
- version: v8.0.0
413416
pr-url: https://github.com/nodejs/node/pull/11985
414417
description: The `msg` parameter can be an `Uint8Array` now.
@@ -423,9 +426,6 @@ changes:
423426
pr-url: https://github.com/nodejs/node/pull/4374
424427
description: The `msg` parameter can be an array now. Also, the `offset`
425428
and `length` parameters are optional now.
426-
- version: v12.0.0
427-
pr-url: https://github.com/nodejs/node/pull/26871
428-
description: Added support for sending data on connected sockets.
429429
-->
430430

431431
* `msg` {Buffer|TypedArray|DataView|string|Array} Message to be sent.
@@ -733,16 +733,16 @@ chained.
733733
<!-- YAML
734734
added: v0.11.13
735735
changes:
736-
- version: v8.6.0
737-
pr-url: https://github.com/nodejs/node/pull/14560
738-
description: The `lookup` option is supported.
736+
- version: v11.4.0
737+
pr-url: https://github.com/nodejs/node/pull/23798
738+
description: The `ipv6Only` option is supported.
739739
- version: v8.7.0
740740
pr-url: https://github.com/nodejs/node/pull/13623
741741
description: The `recvBufferSize` and `sendBufferSize` options are
742742
supported now.
743-
- version: v11.4.0
744-
pr-url: https://github.com/nodejs/node/pull/23798
745-
description: The `ipv6Only` option is supported.
743+
- version: v8.6.0
744+
pr-url: https://github.com/nodejs/node/pull/14560
745+
description: The `lookup` option is supported.
746746
-->
747747

748748
* `options` {Object} Available options are:

doc/api/fs.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -1919,12 +1919,12 @@ If `options` is a string, then it specifies the encoding.
19191919
## `fs.exists(path, callback)`
19201920
<!-- YAML
19211921
added: v0.0.2
1922+
deprecated: v1.0.0
19221923
changes:
19231924
- version: v7.6.0
19241925
pr-url: https://github.com/nodejs/node/pull/10739
19251926
description: The `path` parameter can be a WHATWG `URL` object using
19261927
`file:` protocol. Support is currently still *experimental*.
1927-
deprecated: v1.0.0
19281928
-->
19291929

19301930
> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
@@ -2154,6 +2154,10 @@ Synchronous fdatasync(2). Returns `undefined`.
21542154
<!-- YAML
21552155
added: v0.1.95
21562156
changes:
2157+
- version: v10.5.0
2158+
pr-url: https://github.com/nodejs/node/pull/20220
2159+
description: Accepts an additional `options` object to specify whether
2160+
the numeric values returned should be bigint.
21572161
- version: v10.0.0
21582162
pr-url: https://github.com/nodejs/node/pull/12562
21592163
description: The `callback` parameter is no longer optional. Not passing
@@ -2162,10 +2166,6 @@ changes:
21622166
pr-url: https://github.com/nodejs/node/pull/7897
21632167
description: The `callback` parameter is no longer optional. Not passing
21642168
it will emit a deprecation warning with id DEP0013.
2165-
- version: v10.5.0
2166-
pr-url: https://github.com/nodejs/node/pull/20220
2167-
description: Accepts an additional `options` object to specify whether
2168-
the numeric values returned should be bigint.
21692169
-->
21702170

21712171
* `fd` {integer}
@@ -2507,6 +2507,10 @@ Synchronous link(2). Returns `undefined`.
25072507
<!-- YAML
25082508
added: v0.1.30
25092509
changes:
2510+
- version: v10.5.0
2511+
pr-url: https://github.com/nodejs/node/pull/20220
2512+
description: Accepts an additional `options` object to specify whether
2513+
the numeric values returned should be bigint.
25102514
- version: v10.0.0
25112515
pr-url: https://github.com/nodejs/node/pull/12562
25122516
description: The `callback` parameter is no longer optional. Not passing
@@ -2519,10 +2523,6 @@ changes:
25192523
pr-url: https://github.com/nodejs/node/pull/7897
25202524
description: The `callback` parameter is no longer optional. Not passing
25212525
it will emit a deprecation warning with id DEP0013.
2522-
- version: v10.5.0
2523-
pr-url: https://github.com/nodejs/node/pull/20220
2524-
description: Accepts an additional `options` object to specify whether
2525-
the numeric values returned should be bigint.
25262526
-->
25272527

25282528
* `path` {string|Buffer|URL}
@@ -2542,14 +2542,14 @@ not the file that it refers to.
25422542
<!-- YAML
25432543
added: v0.1.30
25442544
changes:
2545-
- version: v7.6.0
2546-
pr-url: https://github.com/nodejs/node/pull/10739
2547-
description: The `path` parameter can be a WHATWG `URL` object using `file:`
2548-
protocol. Support is currently still *experimental*.
25492545
- version: v10.5.0
25502546
pr-url: https://github.com/nodejs/node/pull/20220
25512547
description: Accepts an additional `options` object to specify whether
25522548
the numeric values returned should be bigint.
2549+
- version: v7.6.0
2550+
pr-url: https://github.com/nodejs/node/pull/10739
2551+
description: The `path` parameter can be a WHATWG `URL` object using `file:`
2552+
protocol. Support is currently still *experimental*.
25532553
-->
25542554

25552555
* `path` {string|Buffer|URL}
@@ -3632,6 +3632,10 @@ utility). Returns `undefined`.
36323632
<!-- YAML
36333633
added: v0.0.2
36343634
changes:
3635+
- version: v10.5.0
3636+
pr-url: https://github.com/nodejs/node/pull/20220
3637+
description: Accepts an additional `options` object to specify whether
3638+
the numeric values returned should be bigint.
36353639
- version: v10.0.0
36363640
pr-url: https://github.com/nodejs/node/pull/12562
36373641
description: The `callback` parameter is no longer optional. Not passing
@@ -3644,10 +3648,6 @@ changes:
36443648
pr-url: https://github.com/nodejs/node/pull/7897
36453649
description: The `callback` parameter is no longer optional. Not passing
36463650
it will emit a deprecation warning with id DEP0013.
3647-
- version: v10.5.0
3648-
pr-url: https://github.com/nodejs/node/pull/20220
3649-
description: Accepts an additional `options` object to specify whether
3650-
the numeric values returned should be bigint.
36513651
-->
36523652

36533653
* `path` {string|Buffer|URL}
@@ -3745,14 +3745,14 @@ Stats {
37453745
<!-- YAML
37463746
added: v0.1.21
37473747
changes:
3748-
- version: v7.6.0
3749-
pr-url: https://github.com/nodejs/node/pull/10739
3750-
description: The `path` parameter can be a WHATWG `URL` object using `file:`
3751-
protocol. Support is currently still *experimental*.
37523748
- version: v10.5.0
37533749
pr-url: https://github.com/nodejs/node/pull/20220
37543750
description: Accepts an additional `options` object to specify whether
37553751
the numeric values returned should be bigint.
3752+
- version: v7.6.0
3753+
pr-url: https://github.com/nodejs/node/pull/10739
3754+
description: The `path` parameter can be a WHATWG `URL` object using `file:`
3755+
protocol. Support is currently still *experimental*.
37563756
-->
37573757

37583758
* `path` {string|Buffer|URL}
@@ -3767,15 +3767,15 @@ Synchronous stat(2).
37673767
<!-- YAML
37683768
added: v0.1.31
37693769
changes:
3770+
- version: v12.0.0
3771+
pr-url: https://github.com/nodejs/node/pull/23724
3772+
description: If the `type` argument is left undefined, Node will autodetect
3773+
`target` type and automatically select `dir` or `file`.
37703774
- version: v7.6.0
37713775
pr-url: https://github.com/nodejs/node/pull/10739
37723776
description: The `target` and `path` parameters can be WHATWG `URL` objects
37733777
using `file:` protocol. Support is currently still
37743778
*experimental*.
3775-
- version: v12.0.0
3776-
pr-url: https://github.com/nodejs/node/pull/23724
3777-
description: If the `type` argument is left undefined, Node will autodetect
3778-
`target` type and automatically select `dir` or `file`.
37793779
-->
37803780

37813781
* `target` {string|Buffer|URL}
@@ -3815,15 +3815,15 @@ example/
38153815
<!-- YAML
38163816
added: v0.1.31
38173817
changes:
3818+
- version: v12.0.0
3819+
pr-url: https://github.com/nodejs/node/pull/23724
3820+
description: If the `type` argument is left undefined, Node will autodetect
3821+
`target` type and automatically select `dir` or `file`.
38183822
- version: v7.6.0
38193823
pr-url: https://github.com/nodejs/node/pull/10739
38203824
description: The `target` and `path` parameters can be WHATWG `URL` objects
38213825
using `file:` protocol. Support is currently still
38223826
*experimental*.
3823-
- version: v12.0.0
3824-
pr-url: https://github.com/nodejs/node/pull/23724
3825-
description: If the `type` argument is left undefined, Node will autodetect
3826-
`target` type and automatically select `dir` or `file`.
38273827
-->
38283828

38293829
* `target` {string|Buffer|URL}

doc/api/http.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1040,20 +1040,20 @@ not be emitted.
10401040
<!-- YAML
10411041
added: v0.1.94
10421042
changes:
1043-
- version: v6.0.0
1044-
pr-url: https://github.com/nodejs/node/pull/4557
1045-
description: The default action of calling `.destroy()` on the `socket`
1046-
will no longer take place if there are listeners attached
1047-
for `'clientError'`.
1043+
- version: v12.0.0
1044+
pr-url: https://github.com/nodejs/node/pull/25605
1045+
description: The default behavior will return a 431 Request Header
1046+
Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
10481047
- version: v9.4.0
10491048
pr-url: https://github.com/nodejs/node/pull/17672
10501049
description: The `rawPacket` is the current buffer that just parsed. Adding
10511050
this buffer to the error object of `'clientError'` event is to
10521051
make it possible that developers can log the broken packet.
1053-
- version: v12.0.0
1054-
pr-url: https://github.com/nodejs/node/pull/25605
1055-
description: The default behavior will return a 431 Request Header
1056-
Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
1052+
- version: v6.0.0
1053+
pr-url: https://github.com/nodejs/node/pull/4557
1054+
description: The default action of calling `.destroy()` on the `socket`
1055+
will no longer take place if there are listeners attached
1056+
for `'clientError'`.
10571057
-->
10581058

10591059
* `exception` {Error}

doc/api/http2.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2075,6 +2075,10 @@ changes:
20752075
pr-url: https://github.com/nodejs/node/pull/27782
20762076
description: The `options` parameter now supports `net.createServer()`
20772077
options.
2078+
- version: v9.6.0
2079+
pr-url: https://github.com/nodejs/node/pull/15752
2080+
description: Added the `Http1IncomingMessage` and `Http1ServerResponse`
2081+
option.
20782082
- version: v8.9.3
20792083
pr-url: https://github.com/nodejs/node/pull/17105
20802084
description: Added the `maxOutstandingPings` option with a default limit of
@@ -2083,10 +2087,6 @@ changes:
20832087
pr-url: https://github.com/nodejs/node/pull/16676
20842088
description: Added the `maxHeaderListPairs` option with a default limit of
20852089
128 header pairs.
2086-
- version: v9.6.0
2087-
pr-url: https://github.com/nodejs/node/pull/15752
2088-
description: Added the `Http1IncomingMessage` and `Http1ServerResponse`
2089-
option.
20902090
-->
20912091

20922092
* `options` {Object}

doc/api/https.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ separate module.
1313
<!-- YAML
1414
added: v0.4.5
1515
changes:
16+
- version: v5.3.0
17+
pr-url: https://github.com/nodejs/node/pull/4252
18+
description: support `0` `maxCachedSessions` to disable TLS session caching.
1619
- version: v2.5.0
1720
pr-url: https://github.com/nodejs/node/pull/2228
1821
description: parameter `maxCachedSessions` added to `options` for TLS
1922
sessions reuse.
20-
- version: v5.3.0
21-
pr-url: https://github.com/nodejs/node/pull/4252
22-
description: support `0` `maxCachedSessions` to disable TLS session caching.
2323
-->
2424

2525
An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See

doc/api/packages.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -882,24 +882,24 @@ as ES modules and `.cjs` files are always treated as CommonJS.
882882
added: v12.7.0
883883
changes:
884884
- version:
885-
- v13.2.0
885+
- v14.13.0
886+
pr-url: https://github.com/nodejs/node/pull/34718
887+
description: Add support for `"exports"` patterns.
888+
- version:
889+
- v13.7.0
886890
- v12.16.0
887-
pr-url: https://github.com/nodejs/node/pull/29978
888-
description: Implement conditional exports.
891+
pr-url: https://github.com/nodejs/node/pull/31008
892+
description: Implement logical conditional exports ordering.
889893
- version:
890894
- v13.7.0
891895
- v12.16.0
892896
pr-url: https://github.com/nodejs/node/pull/31001
893897
description: Remove the `--experimental-conditional-exports` option.
894898
- version:
895-
- v13.7.0
899+
- v13.2.0
896900
- v12.16.0
897-
pr-url: https://github.com/nodejs/node/pull/31008
898-
description: Implement logical conditional exports ordering.
899-
- version:
900-
- v14.13.0
901-
pr-url: https://github.com/nodejs/node/pull/34718
902-
description: Add support for `"exports"` patterns.
901+
pr-url: https://github.com/nodejs/node/pull/29978
902+
description: Implement conditional exports.
903903
-->
904904

905905
* Type: {Object} | {string} | {string[]}

doc/api/process.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2498,12 +2498,12 @@ To get the version string without the prepended _v_, use
24982498
<!-- YAML
24992499
added: v0.2.0
25002500
changes:
2501-
- version: v4.2.0
2502-
pr-url: https://github.com/nodejs/node/pull/3102
2503-
description: The `icu` property is now supported.
25042501
- version: v9.0.0
25052502
pr-url: https://github.com/nodejs/node/pull/15785
25062503
description: The `v8` property now includes a Node.js specific suffix.
2504+
- version: v4.2.0
2505+
pr-url: https://github.com/nodejs/node/pull/3102
2506+
description: The `icu` property is now supported.
25072507
-->
25082508

25092509
* {Object}

doc/api/stream.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1645,15 +1645,15 @@ const cleanup = finished(rs, (err) => {
16451645
<!-- YAML
16461646
added: v10.0.0
16471647
changes:
1648-
- version: v13.10.0
1649-
pr-url: https://github.com/nodejs/node/pull/31223
1650-
description: Add support for async generators.
16511648
- version: v14.0.0
16521649
pr-url: https://github.com/nodejs/node/pull/32158
16531650
description: The `pipeline(..., cb)` will wait for the `'close'` event
16541651
before invoking the callback. The implementation tries to
16551652
detect legacy streams and only apply this behavior to streams
16561653
which are expected to emit `'close'`.
1654+
- version: v13.10.0
1655+
pr-url: https://github.com/nodejs/node/pull/31223
1656+
description: Add support for async generators.
16571657
-->
16581658

16591659
* `streams` {Stream[]|Iterable[]|AsyncIterable[]|Function[]}
@@ -2201,15 +2201,15 @@ constructor and implement the [`readable._read()`][] method.
22012201
#### `new stream.Readable([options])`
22022202
<!-- YAML
22032203
changes:
2204+
- version: v14.0.0
2205+
pr-url: https://github.com/nodejs/node/pull/30623
2206+
description: Change `autoDestroy` option default to `true`.
22042207
- version:
22052208
- v11.2.0
22062209
- v10.16.0
22072210
pr-url: https://github.com/nodejs/node/pull/22795
22082211
description: Add `autoDestroy` option to automatically `destroy()` the
22092212
stream when it emits `'end'` or errors.
2210-
- version: v14.0.0
2211-
pr-url: https://github.com/nodejs/node/pull/30623
2212-
description: Change `autoDestroy` option default to `true`.
22132213
-->
22142214

22152215
* `options` {Object}

0 commit comments

Comments
 (0)