Skip to content

Commit f4f0266

Browse files
BridgeARMylesBorins
authored andcommitted
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]>
1 parent 07845fc commit f4f0266

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

‎lib/internal/errors.js‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,10 +536,14 @@ E('ERR_HTTP2_GOAWAY_SESSION',
536536
E('ERR_HTTP2_HEADERS_AFTER_RESPOND',
537537
'Cannot specify additional headers after response initiated',Error);
538538
E('ERR_HTTP2_HEADERS_SENT','Response has already been initiated.',Error);
539+
540+
// This should probably be a `TypeError`.
539541
E('ERR_HTTP2_HEADER_SINGLE_VALUE',
540542
'Header field "%s" must have only a single value',Error);
541543
E('ERR_HTTP2_INFO_STATUS_NOT_ALLOWED',
542544
'Informational status codes cannot be used',RangeError);
545+
546+
// This should probably be a `TypeError`.
543547
E('ERR_HTTP2_INVALID_CONNECTION_HEADERS',
544548
'HTTP/1 Connection specific headers are forbidden: "%s"',Error);
545549
E('ERR_HTTP2_INVALID_HEADER_VALUE',
@@ -548,6 +552,8 @@ E('ERR_HTTP2_INVALID_INFO_STATUS',
548552
'Invalid informational status code: %s',RangeError);
549553
E('ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH',
550554
'Packed settings length must be a multiple of six',RangeError);
555+
556+
// This should probably be a `TypeError`.
551557
E('ERR_HTTP2_INVALID_PSEUDOHEADER',
552558
'"%s" is an invalid pseudoheader or is used incorrectly',Error);
553559
E('ERR_HTTP2_INVALID_SESSION','The session has been destroyed',Error);
@@ -566,6 +572,8 @@ E('ERR_HTTP2_PAYLOAD_FORBIDDEN',
566572
'Responses with %s status must not have a payload',Error);
567573
E('ERR_HTTP2_PING_CANCEL','HTTP2 ping cancelled',Error);
568574
E('ERR_HTTP2_PING_LENGTH','HTTP2 ping payload must be 8 bytes',RangeError);
575+
576+
// This should probably be a `TypeError`.
569577
E('ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED',
570578
'Cannot set HTTP/2 pseudo-headers',Error);
571579
E('ERR_HTTP2_PUSH_DISABLED','HTTP/2 client has disabled push streams',Error);
@@ -611,8 +619,12 @@ E('ERR_INVALID_BUFFER_SIZE',
611619
'Buffer size must be a multiple of %s',RangeError);
612620
E('ERR_INVALID_CALLBACK','Callback must be a function',TypeError);
613621
E('ERR_INVALID_CHAR',invalidChar,TypeError);//Check falsy "Error" entries.
622+
623+
// This should probably be a `TypeError`.
614624
E('ERR_INVALID_CURSOR_POS',
615625
'Cannot set cursor row without setting its column',Error);
626+
627+
// This should probably be a `TypeError`.
616628
E('ERR_INVALID_DOMAIN_NAME','Unable to determine the domain name',Error);
617629
E('ERR_INVALID_FD',
618630
'"fd" must be a positive integer: %s',RangeError);
@@ -622,6 +634,7 @@ E('ERR_INVALID_FILE_URL_HOST',
622634
E('ERR_INVALID_FILE_URL_PATH','File URL path %s',TypeError);
623635
E('ERR_INVALID_HANDLE_TYPE','This handle type cannot be sent',TypeError);
624636
E('ERR_INVALID_HTTP_TOKEN','%s must be a valid HTTP token ["%s"]',TypeError);
637+
// The `Error` should probably be a `TypeError`.
625638
E('ERR_INVALID_IP_ADDRESS','Invalid IP address: %s',TypeError,Error);
626639
E('ERR_INVALID_OPT_VALUE',(name,value)=>
627640
`The value "${String(value)}" is invalid for option "${name}"`,
@@ -631,7 +644,11 @@ E('ERR_INVALID_OPT_VALUE_ENCODING',
631644
'The value "%s" is invalid for option "encoding"',TypeError);
632645
E('ERR_INVALID_PERFORMANCE_MARK',
633646
'The "%s" performance mark has not been set',Error);
647+
648+
// This should probably be a `TypeError`.
634649
E('ERR_INVALID_PROTOCOL','Protocol "%s" not supported. Expected "%s"',Error);
650+
651+
// This should probably be a `TypeError`.
635652
E('ERR_INVALID_REPL_EVAL_CONFIG',
636653
'Cannot specify both "breakEvalOnSigint" and "eval" for REPL',Error);
637654
E('ERR_INVALID_SYNC_FORK_INPUT',
@@ -703,6 +720,8 @@ E('ERR_TLS_REQUIRED_SERVER_NAME',
703720
E('ERR_TLS_SESSION_ATTACK','TLS session renegotiation attack detected',Error);
704721
E('ERR_TRANSFORM_ALREADY_TRANSFORMING',
705722
'Calling transform done when still transforming',Error);
723+
724+
// This should probably be a `RangeError`.
706725
E('ERR_TRANSFORM_WITH_LENGTH_0',
707726
'Calling transform done when writableState.length != 0',Error);
708727
E('ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET',
@@ -717,14 +736,20 @@ E('ERR_UNHANDLED_ERROR',
717736
return`${msg} (${err})`;
718737
},Error);
719738
E('ERR_UNKNOWN_ENCODING','Unknown encoding: %s',TypeError);
739+
740+
// This should probably be a `TypeError`.
720741
E('ERR_UNKNOWN_FILE_EXTENSION','Unknown file extension: %s',Error);
721742
E('ERR_UNKNOWN_MODULE_FORMAT','Unknown module format: %s',RangeError);
722743
E('ERR_UNKNOWN_SIGNAL','Unknown signal: %s',TypeError);
723744
E('ERR_UNKNOWN_STDIN_TYPE','Unknown stdin file type',Error);
745+
746+
// This should probably be a `TypeError`.
724747
E('ERR_UNKNOWN_STREAM_TYPE','Unknown stream file type',Error);
725748
E('ERR_V8BREAKITERATOR',
726749
'Full ICU data not installed. See https://github.com/nodejs/node/wiki/Intl',
727750
Error);
751+
752+
// This should probably be a `TypeError`.
728753
E('ERR_VALID_PERFORMANCE_ENTRY_TYPE',
729754
'At least one valid performance entry type is required',Error);
730755
E('ERR_VALUE_OUT_OF_RANGE',(start,end,value)=>{

0 commit comments

Comments
(0)