From 8dfb89bed099cfb5fb6cab412309504558d172d6 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 15 Sep 2020 15:28:56 -0700 Subject: [PATCH] doc: alphabetize error list MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/35219 Reviewed-By: Daijiro Wachi Reviewed-By: Michaël Zasso Reviewed-By: Trivikram Kamat --- doc/api/errors.md | 112 +++++++++++++++++++++++----------------------- 1 file changed, 57 insertions(+), 55 deletions(-) diff --git a/doc/api/errors.md b/doc/api/errors.md index 1041d10b5c4129..f69b9e968359c6 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -708,26 +708,26 @@ STDERR/STDOUT, and the data's length is longer than the `maxBuffer` option. `Console` was instantiated without `stdout` stream, or `Console` has a non-writable `stdout` or `stderr` stream. - -### `ERR_CONTEXT_NOT_INITIALIZED` + +### `ERR_CONSTRUCT_CALL_INVALID` + -The vm context passed into the API is not yet initialized. This could happen -when an error occurs (and is caught) during the creation of the -context, for example, when the allocation fails or the maximum call stack -size is reached when the context is created. +A class constructor was called that is not callable. ### `ERR_CONSTRUCT_CALL_REQUIRED` A constructor for a class was called without `new`. - -### `ERR_CONSTRUCT_CALL_INVALID` - + +### `ERR_CONTEXT_NOT_INITIALIZED` -A class constructor was called that is not callable. +The vm context passed into the API is not yet initialized. This could happen +when an error occurs (and is caught) during the creation of the +context, for example, when the allocation fails or the maximum call stack +size is reached when the context is created. ### `ERR_CPU_USAGE` @@ -940,11 +940,6 @@ allowed size for a `Buffer`. An invalid symlink type was passed to the [`fs.symlink()`][] or [`fs.symlinkSync()`][] methods. - -### `ERR_HTTP_REQUEST_TIMEOUT` - -The client has not sent the entire request within the allowed time. - ### `ERR_HTTP_HEADERS_SENT` @@ -1005,6 +1000,12 @@ A non-specific HTTP/2 error has occurred. New HTTP/2 Streams may not be opened after the `Http2Session` has received a `GOAWAY` frame from the connected peer. + +### `ERR_HTTP2_HEADER_SINGLE_VALUE` + +Multiple values were provided for an HTTP/2 header field that was required to +have only a single value. + ### `ERR_HTTP2_HEADERS_AFTER_RESPOND` @@ -1015,12 +1016,6 @@ An additional headers was specified after an HTTP/2 response was initiated. An attempt was made to send multiple response headers. - -### `ERR_HTTP2_HEADER_SINGLE_VALUE` - -Multiple values were provided for an HTTP/2 header field that was required to -have only a single value. - ### `ERR_HTTP2_INFO_STATUS_NOT_ALLOWED` @@ -1221,12 +1216,6 @@ is set for the `Http2Stream`. `http2.connect()` was passed a URL that uses any protocol other than `http:` or `https:`. - -### `ERR_INTERNAL_ASSERTION` - -There was a bug in Node.js or incorrect usage of Node.js internals. -To fix the error, open an issue at . - ### `ERR_INCOMPATIBLE_OPTION_PAIR` @@ -1287,6 +1276,12 @@ before it was connected. An API was called on the main thread that can only be used from the worker thread. + +### `ERR_INTERNAL_ASSERTION` + +There was a bug in Node.js or incorrect usage of Node.js internals. +To fix the error, open an issue at . + ### `ERR_INVALID_ADDRESS_FAMILY` @@ -1598,12 +1593,6 @@ strict compliance with the API specification (which in some cases may accept `func(undefined)` and `func()` are treated identically, and the [`ERR_INVALID_ARG_TYPE`][] error code may be used instead. - -### `ERR_MISSING_OPTION` - -For APIs that accept options objects, some options might be mandatory. This code -is thrown if a required option is missing. - ### `ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST` @@ -1611,6 +1600,12 @@ An object that needs to be explicitly listed in the `transferList` argument is in the object passed to a `postMessage()` call, but is not provided in the `transferList` for that call. Usually, this is a `MessagePort`. + +### `ERR_MISSING_OPTION` + +For APIs that accept options objects, some options might be mandatory. This code +is thrown if a required option is missing. + ### `ERR_MISSING_PASSPHRASE` @@ -1818,6 +1813,12 @@ A string was provided for a Subresource Integrity check, but was unable to be parsed. Check the format of integrity attributes by looking at the [Subresource Integrity specification][]. + +### `ERR_STREAM_ALREADY_FINISHED` + +A stream method was called that cannot complete because the stream was +finished. + ### `ERR_STREAM_CANNOT_PIPE` @@ -1829,12 +1830,6 @@ An attempt was made to call [`stream.pipe()`][] on a [`Writable`][] stream. A stream method was called that cannot complete because the stream was destroyed using `stream.destroy()`. - -### `ERR_STREAM_ALREADY_FINISHED` - -A stream method was called that cannot complete because the stream was -finished. - ### `ERR_STREAM_NULL_VALUES` @@ -1924,15 +1919,6 @@ added: v13.3.0 The context must be a `SecureContext`. - -### `ERR_TLS_INVALID_STATE` - - -The TLS socket must be connected and securily established. Ensure the 'secure' -event is emitted before continuing. - ### `ERR_TLS_INVALID_PROTOCOL_METHOD` @@ -1944,12 +1930,28 @@ disabled because it is insecure. Valid TLS protocol versions are `'TLSv1'`, `'TLSv1.1'`, or `'TLSv1.2'`. + +### `ERR_TLS_INVALID_STATE` + + +The TLS socket must be connected and securily established. Ensure the 'secure' +event is emitted before continuing. + ### `ERR_TLS_PROTOCOL_VERSION_CONFLICT` Attempting to set a TLS protocol `minVersion` or `maxVersion` conflicts with an attempt to set the `secureProtocol` explicitly. Use one mechanism or the other. + +### `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` + +Failed to set PSK identity hint. Hint may be too long. + ### `ERR_TLS_RENEGOTIATION_DISABLED` @@ -1973,11 +1975,6 @@ vector for denial-of-service attacks. An attempt was made to issue Server Name Indication from a TLS server-side socket, which is only valid from a client. - -### `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` - -Failed to set PSK identity hint. Hint may be too long. - ### `ERR_TRACE_EVENTS_CATEGORY_REQUIRED` @@ -2332,6 +2329,11 @@ removed: v10.0.0 Used when an invalid character is found in an HTTP response status message (reason phrase). + +### `ERR_HTTP_REQUEST_TIMEOUT` + +The client has not sent the entire request within the allowed time. + ### `ERR_INDEX_OUT_OF_RANGE`