Skip to content

Commit 02db136

Browse files
TrottMylesBorins
authored andcommitted
doc: alphabetize error list
Backport-PR-URL: #35318 PR-URL: #35219 Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 46a4154 commit 02db136

File tree

1 file changed

+57
-55
lines changed

1 file changed

+57
-55
lines changed

doc/api/errors.md

Lines changed: 57 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -708,26 +708,26 @@ STDERR/STDOUT, and the data's length is longer than the `maxBuffer` option.
708708
`Console` was instantiated without `stdout` stream, or `Console` has a
709709
non-writable `stdout` or `stderr` stream.
710710

711-
<a id="ERR_CONTEXT_NOT_INITIALIZED"></a>
712-
### `ERR_CONTEXT_NOT_INITIALIZED`
711+
<a id="ERR_CONSTRUCT_CALL_INVALID"></a>
712+
### `ERR_CONSTRUCT_CALL_INVALID`
713+
<!--
714+
added: v12.5.0
715+
-->
713716

714-
The vm context passed into the API is not yet initialized. This could happen
715-
when an error occurs (and is caught) during the creation of the
716-
context, for example, when the allocation fails or the maximum call stack
717-
size is reached when the context is created.
717+
A class constructor was called that is not callable.
718718

719719
<a id="ERR_CONSTRUCT_CALL_REQUIRED"></a>
720720
### `ERR_CONSTRUCT_CALL_REQUIRED`
721721

722722
A constructor for a class was called without `new`.
723723

724-
<a id="ERR_CONSTRUCT_CALL_INVALID"></a>
725-
### `ERR_CONSTRUCT_CALL_INVALID`
726-
<!--
727-
added: v12.5.0
728-
-->
724+
<a id="ERR_CONTEXT_NOT_INITIALIZED"></a>
725+
### `ERR_CONTEXT_NOT_INITIALIZED`
729726

730-
A class constructor was called that is not callable.
727+
The vm context passed into the API is not yet initialized. This could happen
728+
when an error occurs (and is caught) during the creation of the
729+
context, for example, when the allocation fails or the maximum call stack
730+
size is reached when the context is created.
731731

732732
<a id="ERR_CPU_USAGE"></a>
733733
### `ERR_CPU_USAGE`
@@ -940,11 +940,6 @@ allowed size for a `Buffer`.
940940
An invalid symlink type was passed to the [`fs.symlink()`][] or
941941
[`fs.symlinkSync()`][] methods.
942942

943-
<a id="ERR_HTTP_REQUEST_TIMEOUT"></a>
944-
### `ERR_HTTP_REQUEST_TIMEOUT`
945-
946-
The client has not sent the entire request within the allowed time.
947-
948943
<a id="ERR_HTTP_HEADERS_SENT"></a>
949944
### `ERR_HTTP_HEADERS_SENT`
950945

@@ -1005,6 +1000,12 @@ A non-specific HTTP/2 error has occurred.
10051000
New HTTP/2 Streams may not be opened after the `Http2Session` has received a
10061001
`GOAWAY` frame from the connected peer.
10071002

1003+
<a id="ERR_HTTP2_HEADER_SINGLE_VALUE"></a>
1004+
### `ERR_HTTP2_HEADER_SINGLE_VALUE`
1005+
1006+
Multiple values were provided for an HTTP/2 header field that was required to
1007+
have only a single value.
1008+
10081009
<a id="ERR_HTTP2_HEADERS_AFTER_RESPOND"></a>
10091010
### `ERR_HTTP2_HEADERS_AFTER_RESPOND`
10101011

@@ -1015,12 +1016,6 @@ An additional headers was specified after an HTTP/2 response was initiated.
10151016

10161017
An attempt was made to send multiple response headers.
10171018

1018-
<a id="ERR_HTTP2_HEADER_SINGLE_VALUE"></a>
1019-
### `ERR_HTTP2_HEADER_SINGLE_VALUE`
1020-
1021-
Multiple values were provided for an HTTP/2 header field that was required to
1022-
have only a single value.
1023-
10241019
<a id="ERR_HTTP2_INFO_STATUS_NOT_ALLOWED"></a>
10251020
### `ERR_HTTP2_INFO_STATUS_NOT_ALLOWED`
10261021

@@ -1221,12 +1216,6 @@ is set for the `Http2Stream`.
12211216
`http2.connect()` was passed a URL that uses any protocol other than `http:` or
12221217
`https:`.
12231218

1224-
<a id="ERR_INTERNAL_ASSERTION"></a>
1225-
### `ERR_INTERNAL_ASSERTION`
1226-
1227-
There was a bug in Node.js or incorrect usage of Node.js internals.
1228-
To fix the error, open an issue at <https://github.com/nodejs/node/issues>.
1229-
12301219
<a id="ERR_INCOMPATIBLE_OPTION_PAIR"></a>
12311220
### `ERR_INCOMPATIBLE_OPTION_PAIR`
12321221

@@ -1287,6 +1276,12 @@ before it was connected.
12871276
An API was called on the main thread that can only be used from
12881277
the worker thread.
12891278

1279+
<a id="ERR_INTERNAL_ASSERTION"></a>
1280+
### `ERR_INTERNAL_ASSERTION`
1281+
1282+
There was a bug in Node.js or incorrect usage of Node.js internals.
1283+
To fix the error, open an issue at <https://github.com/nodejs/node/issues>.
1284+
12901285
<a id="ERR_INVALID_ADDRESS_FAMILY"></a>
12911286
### `ERR_INVALID_ADDRESS_FAMILY`
12921287

@@ -1598,19 +1593,19 @@ strict compliance with the API specification (which in some cases may accept
15981593
`func(undefined)` and `func()` are treated identically, and the
15991594
[`ERR_INVALID_ARG_TYPE`][] error code may be used instead.
16001595

1601-
<a id="ERR_MISSING_OPTION"></a>
1602-
### `ERR_MISSING_OPTION`
1603-
1604-
For APIs that accept options objects, some options might be mandatory. This code
1605-
is thrown if a required option is missing.
1606-
16071596
<a id="ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST"></a>
16081597
### `ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`
16091598

16101599
An object that needs to be explicitly listed in the `transferList` argument
16111600
is in the object passed to a `postMessage()` call, but is not provided
16121601
in the `transferList` for that call. Usually, this is a `MessagePort`.
16131602

1603+
<a id="ERR_MISSING_OPTION"></a>
1604+
### `ERR_MISSING_OPTION`
1605+
1606+
For APIs that accept options objects, some options might be mandatory. This code
1607+
is thrown if a required option is missing.
1608+
16141609
<a id="ERR_MISSING_PASSPHRASE"></a>
16151610
### `ERR_MISSING_PASSPHRASE`
16161611

@@ -1818,6 +1813,12 @@ A string was provided for a Subresource Integrity check, but was unable to be
18181813
parsed. Check the format of integrity attributes by looking at the
18191814
[Subresource Integrity specification][].
18201815

1816+
<a id="ERR_STREAM_ALREADY_FINISHED"></a>
1817+
### `ERR_STREAM_ALREADY_FINISHED`
1818+
1819+
A stream method was called that cannot complete because the stream was
1820+
finished.
1821+
18211822
<a id="ERR_STREAM_CANNOT_PIPE"></a>
18221823
### `ERR_STREAM_CANNOT_PIPE`
18231824

@@ -1829,12 +1830,6 @@ An attempt was made to call [`stream.pipe()`][] on a [`Writable`][] stream.
18291830
A stream method was called that cannot complete because the stream was
18301831
destroyed using `stream.destroy()`.
18311832

1832-
<a id="ERR_STREAM_ALREADY_FINISHED"></a>
1833-
### `ERR_STREAM_ALREADY_FINISHED`
1834-
1835-
A stream method was called that cannot complete because the stream was
1836-
finished.
1837-
18381833
<a id="ERR_STREAM_NULL_VALUES"></a>
18391834
### `ERR_STREAM_NULL_VALUES`
18401835

@@ -1924,15 +1919,6 @@ added: v13.3.0
19241919

19251920
The context must be a `SecureContext`.
19261921

1927-
<a id="ERR_TLS_INVALID_STATE"></a>
1928-
### `ERR_TLS_INVALID_STATE`
1929-
<!-- YAML
1930-
added: v13.10.0
1931-
-->
1932-
1933-
The TLS socket must be connected and securily established. Ensure the 'secure'
1934-
event is emitted before continuing.
1935-
19361922
<a id="ERR_TLS_INVALID_PROTOCOL_METHOD"></a>
19371923
### `ERR_TLS_INVALID_PROTOCOL_METHOD`
19381924

@@ -1944,12 +1930,28 @@ disabled because it is insecure.
19441930

19451931
Valid TLS protocol versions are `'TLSv1'`, `'TLSv1.1'`, or `'TLSv1.2'`.
19461932

1933+
<a id="ERR_TLS_INVALID_STATE"></a>
1934+
### `ERR_TLS_INVALID_STATE`
1935+
<!-- YAML
1936+
added:
1937+
- v13.10.0
1938+
- v12.17.0
1939+
-->
1940+
1941+
The TLS socket must be connected and securily established. Ensure the 'secure'
1942+
event is emitted before continuing.
1943+
19471944
<a id="ERR_TLS_PROTOCOL_VERSION_CONFLICT"></a>
19481945
### `ERR_TLS_PROTOCOL_VERSION_CONFLICT`
19491946

19501947
Attempting to set a TLS protocol `minVersion` or `maxVersion` conflicts with an
19511948
attempt to set the `secureProtocol` explicitly. Use one mechanism or the other.
19521949

1950+
<a id="ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED"></a>
1951+
### `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED`
1952+
1953+
Failed to set PSK identity hint. Hint may be too long.
1954+
19531955
<a id="ERR_TLS_RENEGOTIATION_DISABLED"></a>
19541956
### `ERR_TLS_RENEGOTIATION_DISABLED`
19551957

@@ -1973,11 +1975,6 @@ vector for denial-of-service attacks.
19731975
An attempt was made to issue Server Name Indication from a TLS server-side
19741976
socket, which is only valid from a client.
19751977

1976-
<a id="ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED"></a>
1977-
### `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED`
1978-
1979-
Failed to set PSK identity hint. Hint may be too long.
1980-
19811978
<a id="ERR_TRACE_EVENTS_CATEGORY_REQUIRED"></a>
19821979
### `ERR_TRACE_EVENTS_CATEGORY_REQUIRED`
19831980

@@ -2332,6 +2329,11 @@ removed: v10.0.0
23322329
Used when an invalid character is found in an HTTP response status message
23332330
(reason phrase).
23342331

2332+
<a id="ERR_HTTP_REQUEST_TIMEOUT"></a>
2333+
### `ERR_HTTP_REQUEST_TIMEOUT`
2334+
2335+
The client has not sent the entire request within the allowed time.
2336+
23352337
<a id="ERR_INDEX_OUT_OF_RANGE"></a>
23362338
### `ERR_INDEX_OUT_OF_RANGE`
23372339
<!-- YAML

0 commit comments

Comments
 (0)