errors: add comments about falsy error types

Some error types are not properly set. This adds comments which
ones are probably falty and to what they should be set instead.

Backport-PR-URL: #19244
PR-URL: #18857
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Joyee Cheung <[email protected]>

Author: BridgeAR

lib/internal/errors.js

@@ -536,10 +536,14 @@ E('ERR_HTTP2_GOAWAY_SESSION',
 E('ERR_HTTP2_HEADERS_AFTER_RESPOND',
   'Cannot specify additional headers after response initiated', Error);
 E('ERR_HTTP2_HEADERS_SENT', 'Response has already been initiated.', Error);
+
+// This should probably be a `TypeError`.
 E('ERR_HTTP2_HEADER_SINGLE_VALUE',
   'Header field "%s" must have only a single value', Error);
 E('ERR_HTTP2_INFO_STATUS_NOT_ALLOWED',
   'Informational status codes cannot be used', RangeError);
+
+// This should probably be a `TypeError`.
 E('ERR_HTTP2_INVALID_CONNECTION_HEADERS',
   'HTTP/1 Connection specific headers are forbidden: "%s"', Error);
 E('ERR_HTTP2_INVALID_HEADER_VALUE',
@@ -548,6 +552,8 @@ E('ERR_HTTP2_INVALID_INFO_STATUS',
   'Invalid informational status code: %s', RangeError);
 E('ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH',
   'Packed settings length must be a multiple of six', RangeError);
+
+// This should probably be a `TypeError`.
 E('ERR_HTTP2_INVALID_PSEUDOHEADER',
   '"%s" is an invalid pseudoheader or is used incorrectly', Error);
 E('ERR_HTTP2_INVALID_SESSION', 'The session has been destroyed', Error);
@@ -566,6 +572,8 @@ E('ERR_HTTP2_PAYLOAD_FORBIDDEN',
   'Responses with %s status must not have a payload', Error);
 E('ERR_HTTP2_PING_CANCEL', 'HTTP2 ping cancelled', Error);
 E('ERR_HTTP2_PING_LENGTH', 'HTTP2 ping payload must be 8 bytes', RangeError);
+
+// This should probably be a `TypeError`.
 E('ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED',
   'Cannot set HTTP/2 pseudo-headers', Error);
 E('ERR_HTTP2_PUSH_DISABLED', 'HTTP/2 client has disabled push streams', Error);
@@ -611,8 +619,12 @@ E('ERR_INVALID_BUFFER_SIZE',
   'Buffer size must be a multiple of %s', RangeError);
 E('ERR_INVALID_CALLBACK', 'Callback must be a function', TypeError);
 E('ERR_INVALID_CHAR', invalidChar, TypeError); //Check falsy "Error" entries.
+
+// This should probably be a `TypeError`.
 E('ERR_INVALID_CURSOR_POS',
   'Cannot set cursor row without setting its column', Error);
+
+// This should probably be a `TypeError`.
 E('ERR_INVALID_DOMAIN_NAME', 'Unable to determine the domain name', Error);
 E('ERR_INVALID_FD',
   '"fd" must be a positive integer: %s', RangeError);
@@ -622,6 +634,7 @@ E('ERR_INVALID_FILE_URL_HOST',
 E('ERR_INVALID_FILE_URL_PATH', 'File URL path %s', TypeError);
 E('ERR_INVALID_HANDLE_TYPE', 'This handle type cannot be sent', TypeError);
 E('ERR_INVALID_HTTP_TOKEN', '%s must be a valid HTTP token ["%s"]', TypeError);
+// The `Error` should probably be a `TypeError`.
 E('ERR_INVALID_IP_ADDRESS', 'Invalid IP address: %s', TypeError, Error);
 E('ERR_INVALID_OPT_VALUE', (name, value) =>
   `The value "${String(value)}" is invalid for option "${name}"`,
@@ -631,7 +644,11 @@ E('ERR_INVALID_OPT_VALUE_ENCODING',
   'The value "%s" is invalid for option "encoding"', TypeError);
 E('ERR_INVALID_PERFORMANCE_MARK',
   'The "%s" performance mark has not been set', Error);
+
+// This should probably be a `TypeError`.
 E('ERR_INVALID_PROTOCOL', 'Protocol "%s" not supported. Expected "%s"', Error);
+
+// This should probably be a `TypeError`.
 E('ERR_INVALID_REPL_EVAL_CONFIG',
   'Cannot specify both "breakEvalOnSigint" and "eval" for REPL', Error);
 E('ERR_INVALID_SYNC_FORK_INPUT',
@@ -703,6 +720,8 @@ E('ERR_TLS_REQUIRED_SERVER_NAME',
 E('ERR_TLS_SESSION_ATTACK', 'TLS session renegotiation attack detected', Error);
 E('ERR_TRANSFORM_ALREADY_TRANSFORMING',
   'Calling transform done when still transforming', Error);
+
+// This should probably be a `RangeError`.
 E('ERR_TRANSFORM_WITH_LENGTH_0',
   'Calling transform done when writableState.length != 0', Error);
 E('ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET',
@@ -717,14 +736,20 @@ E('ERR_UNHANDLED_ERROR',
     return `${msg} (${err})`;
   }, Error);
 E('ERR_UNKNOWN_ENCODING', 'Unknown encoding: %s', TypeError);
+
+// This should probably be a `TypeError`.
 E('ERR_UNKNOWN_FILE_EXTENSION', 'Unknown file extension: %s', Error);
 E('ERR_UNKNOWN_MODULE_FORMAT', 'Unknown module format: %s', RangeError);
 E('ERR_UNKNOWN_SIGNAL', 'Unknown signal: %s', TypeError);
 E('ERR_UNKNOWN_STDIN_TYPE', 'Unknown stdin file type', Error);
+
+// This should probably be a `TypeError`.
 E('ERR_UNKNOWN_STREAM_TYPE', 'Unknown stream file type', Error);
 E('ERR_V8BREAKITERATOR',
   'Full ICU data not installed. See https://github.com/nodejs/node/wiki/Intl',
   Error);
+
+// This should probably be a `TypeError`.
 E('ERR_VALID_PERFORMANCE_ENTRY_TYPE',
   'At least one valid performance entry type is required', Error);
 E('ERR_VALUE_OUT_OF_RANGE', (start, end, value) => {