Skip to content

Commit 01b98a7

Browse files
jklepatchaddaleax
authored andcommitted
doc: removed redundant mentions to error codes
PR-URL: #13627 Backport-PR-URL: #14175 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
1 parent 697ea62 commit 01b98a7

File tree

1 file changed

+76
-94
lines changed

1 file changed

+76
-94
lines changed

doc/api/errors.md

+76-94
Original file line numberDiff line numberDiff line change
@@ -567,9 +567,8 @@ found [here][online].
567567
<a id="ERR_ARG_NOT_ITERABLE"></a>
568568
### ERR_ARG_NOT_ITERABLE
569569

570-
The `'ERR_ARG_NOT_ITERABLE'` error code is used generically to identify that an
571-
iterable argument (i.e. a value that works with `for...of` loops) is required,
572-
but not provided to a Node.js API.
570+
Used generically to identify that an iterable argument (i.e. a value that works
571+
with `for...of` loops) is required, but not provided to a Node.js API.
573572

574573
<a id="ERR_FALSY_VALUE_REJECTION"></a>
575574
### ERR_FALSY_VALUE_REJECTION
@@ -580,58 +579,56 @@ with a falsy value (e.g. `null`).
580579
<a id="ERR_INVALID_ARG_TYPE"></a>
581580
### ERR_INVALID_ARG_TYPE
582581

583-
The `'ERR_INVALID_ARG_TYPE'` error code is used generically to identify that
584-
an argument of the wrong type has been passed to a Node.js API.
582+
Used generically to identify that an argument of the wrong type has been passed
583+
to a Node.js API.
585584

586585
<a id="ERR_INVALID_CALLBACK"></a>
587586
### ERR_INVALID_CALLBACK
588587

589-
The `'ERR_INVALID_CALLBACK'` error code is used generically to identify that
590-
a callback function is required and has not been provided to a Node.js API.
588+
Used generically to identify that a callback function is required and has not
589+
been provided to a Node.js API.
591590

592591
<a id="ERR_INVALID_FILE_URL_HOST"></a>
593592
### ERR_INVALID_FILE_URL_HOST
594593

595-
An error with the `'ERR_INVALID_FILE_URL_HOST'` code may be thrown when a
596-
Node.js API that consumes `file:` URLs (such as certain functions in the
597-
[`fs`][] module) encounters a file URL with an incompatible host. Currently,
598-
this situation can only occur on Unix-like systems, where only `localhost` or
599-
an empty host is supported.
594+
Used when a Node.js API that consumes `file:` URLs (such as certain functions in
595+
the [`fs`][] module) encounters a file URL with an incompatible host. Currently,
596+
this situation can only occur on Unix-like systems, where only `localhost` or an
597+
empty host is supported.
600598

601599
<a id="ERR_INVALID_FILE_URL_PATH"></a>
602600
### ERR_INVALID_FILE_URL_PATH
603601

604-
An error with the `'ERR_INVALID_FILE_URL_PATH'` code may be thrown when a
605-
Node.js API that consumes `file:` URLs (such as certain functions in the
606-
[`fs`][] module) encounters a file URL with an incompatible path. The exact
607-
semantics for determining whether a path can be used is platform-dependent.
602+
Used when a Node.js API that consumes `file:` URLs (such as certain
603+
functions in the [`fs`][] module) encounters a file URL with an incompatible
604+
path. The exact semantics for determining whether a path can be used is
605+
platform-dependent.
608606

609607
<a id="ERR_INVALID_HANDLE_TYPE"></a>
610608
### ERR_INVALID_HANDLE_TYPE
611609

612-
The '`ERR_INVALID_HANDLE_TYPE`' error code is used when an attempt is made to
613-
send an unsupported "handle" over an IPC communication channel to a child
614-
process. See [`child.send()`] and [`process.send()`] for more information.
610+
Used when an attempt is made to send an unsupported "handle" over an IPC
611+
communication channel to a child process. See [`child.send()`] and
612+
[`process.send()`] for more information.
615613

616614
<a id="ERR_INVALID_OPT_VALUE"></a>
617615
### ERR_INVALID_OPT_VALUE
618616

619-
The `'ERR_INVALID_OPT_VALUE'` error code is used generically to identify when
620-
an invalid or unexpected value has been passed in an options object.
617+
Used generically to identify when an invalid or unexpected value has been
618+
passed in an options object.
621619

622620
<a id="ERR_INVALID_SYNC_FORK_INPUT"></a>
623621
### ERR_INVALID_SYNC_FORK_INPUT
624622

625-
The `'ERR_INVALID_SYNC_FORK_INPUT'` error code is used when a `Buffer`,
626-
`Uint8Array` or `string` is provided as stdio input to a synchronous
627-
fork. See the documentation for the [`child_process`](child_process.html)
628-
module for more information.
623+
Used when a `Buffer`, `Uint8Array` or `string` is provided as stdio input to a
624+
synchronous fork. See the documentation for the
625+
[`child_process`](child_process.html) module for more information.
629626

630627
<a id="ERR_INVALID_THIS"></a>
631628
### ERR_INVALID_THIS
632629

633-
The `'ERR_INVALID_THIS'` error code is used generically to identify that a
634-
Node.js API function is called with an incompatible `this` value.
630+
Used generically to identify that a Node.js API function is called with an
631+
incompatible `this` value.
635632

636633
Example:
637634

@@ -647,144 +644,129 @@ urlSearchParams.has.call(buf, 'foo');
647644
<a id="ERR_INVALID_TUPLE"></a>
648645
### ERR_INVALID_TUPLE
649646

650-
An error with code `'ERR_INVALID_TUPLE'` is thrown when an element in the
651-
`iterable` provided to the [WHATWG][WHATWG URL API] [`URLSearchParams`
652-
constructor][`new URLSearchParams(iterable)`] does not represent a `[name,
653-
value]` tuple – that is, if an element is not iterable, or does not consist of
654-
exactly two elements.
647+
Used when an element in the `iterable` provided to the [WHATWG][WHATWG URL
648+
API] [`URLSearchParams`constructor][`new URLSearchParams(iterable)`] does not
649+
represent a `[name, value]` tuple – that is, if an element is not iterable, or
650+
does not consist of exactly two elements.
655651

656652
<a id="ERR_INVALID_URL"></a>
657653
### ERR_INVALID_URL
658654

659-
An error using the `'ERR_INVALID_URL'` code is thrown when an invalid URL is
660-
passed to the [WHATWG][WHATWG URL API] [`URL` constructor][`new URL(input)`] to
661-
be parsed. The thrown error object typically has an additional property
662-
`'input'` that contains the URL that failed to parse.
655+
Used when an invalid URL is passed to the [WHATWG][WHATWG URL API]
656+
[`URL` constructor][`new URL(input)`] to be parsed. The thrown error object
657+
typically has an additional property `'input'` that contains the URL that failed
658+
to parse.
663659

664660
<a id="ERR_INVALID_URL_SCHEME"></a>
665661
### ERR_INVALID_URL_SCHEME
666662

667-
The code `'ERR_INVALID_URL_SCHEME'` is used generically to signify an attempt
668-
to use a URL of an incompatible scheme (aka protocol) for a specific purpose.
669-
It is currently only used in the [WHATWG URL API][] support in the [`fs`][]
670-
module (which only accepts URLs with `'file'` scheme), but may be used in other
671-
Node.js APIs as well in the future.
663+
Used generically to signify an attempt to use a URL of an incompatible scheme
664+
(aka protocol) for a specific purpose. It is currently only used in the
665+
[WHATWG URL API][] support in the [`fs`][] module (which only accepts URLs with
666+
`'file'` scheme), but may be used in other Node.js APIs as well in the future.
672667

673668
<a id="ERR_IPC_CHANNEL_CLOSED"></a>
674669
### ERR_IPC_CHANNEL_CLOSED
675670

676-
The `'ERR_IPC_CHANNEL_CLOSED'` error code is used when an attempt is made to use
677-
an IPC communication channel that has already been closed.
671+
Used when an attempt is made to use an IPC communication channel that has
672+
already been closed.
678673

679674
<a id="ERR_IPC_DISCONNECTED"></a>
680675
### ERR_IPC_DISCONNECTED
681676

682-
The `'ERR_IPC_DISCONNECTED'` error code is used when an attempt is made to
683-
disconnect an already disconnected IPC communication channel between two
684-
Node.js processes. See the documentation for the
685-
[`child_process`](child_process.html) module for more information.
677+
Used when an attempt is made to disconnect an already disconnected IPC
678+
communication channel between two Node.js processes. See the documentation for
679+
the [`child_process`](child_process.html) module for more information.
686680

687681
<a id="ERR_IPC_ONE_PIPE"></a>
688682
### ERR_IPC_ONE_PIPE
689683

690-
The `'ERR_IPC_ONE_PIPE'` error code is used when an attempt is made to create
691-
a child Node.js process using more than one IPC communication channel.
692-
See the documentation for the [`child_process`](child_process.html)
693-
module for more information.
684+
Used when an attempt is made to create a child Node.js process using more than
685+
one IPC communication channel. See the documentation for the
686+
[`child_process`](child_process.html) module for more information.
694687

695688
<a id="ERR_IPC_SYNC_FORK"></a>
696689
### ERR_IPC_SYNC_FORK
697690

698-
The `'ERR_IPC_SYNC_FORK'` error code is used when an attempt is made to open
699-
an IPC communication channel with a synchronous forked Node.js process.
700-
See the documentation for the [`child_process`](child_process.html)
701-
module for more information.
691+
Used when an attempt is made to open an IPC communication channel with a
692+
synchronous forked Node.js process. See the documentation for the
693+
[`child_process`](child_process.html) module for more information.
702694

703695
<a id="ERR_MISSING_ARGS"></a>
704696
### ERR_MISSING_ARGS
705697

706-
The `'ERR_MISSING_ARGS'` error code is a generic error code for instances where
707-
a required argument of a Node.js API is not passed. This is currently only used
708-
in the [WHATWG URL API][] for strict compliance with the specification (which
709-
in some cases may accept `func(undefined)` but not `func()`). In most native
710-
Node.js APIs, `func(undefined)` and `func()` are treated identically, and the
711-
[`ERR_INVALID_ARG_TYPE`][] error code may be used instead.
698+
Used when a required argument of a Node.js API is not passed. This is currently
699+
only used in the [WHATWG URL API][] for strict compliance with the specification
700+
(which in some cases may accept `func(undefined)` but not `func()`). In most
701+
native Node.js APIs, `func(undefined)` and `func()` are treated identically, and
702+
the [`ERR_INVALID_ARG_TYPE`][] error code may be used instead.
712703

713704
<a id="ERR_SOCKET_ALREADY_BOUND"></a>
714705
### ERR_SOCKET_ALREADY_BOUND
715-
An error using the `'ERR_SOCKET_ALREADY_BOUND'` code is thrown when an attempt
716-
is made to bind a socket that has already been bound.
706+
Used when an attempt is made to bind a socket that has already been bound.
717707

718708
<a id="ERR_SOCKET_BAD_PORT"></a>
719709
### ERR_SOCKET_BAD_PORT
720710

721-
An error using the `'ERR_SOCKET_BAD_PORT'` code is thrown when an API
722-
function expecting a port > 0 and < 65536 receives an invalid value.
711+
Used when an API function expecting a port > 0 and < 65536 receives an invalid
712+
value.
723713

724714
<a id="ERR_SOCKET_BAD_TYPE"></a>
725715
### ERR_SOCKET_BAD_TYPE
726716

727-
An error using the `'ERR_SOCKET_BAD_TYPE'` code is thrown when an API
728-
function expecting a socket type (`udp4` or `udp6`) receives an invalid value.
717+
Used when an API function expecting a socket type (`udp4` or `udp6`) receives an
718+
invalid value.
729719

730720
<a id="ERR_SOCKET_CANNOT_SEND"></a>
731721
### ERR_SOCKET_CANNOT_SEND
732722

733-
An error using the `'ERR_SOCKET_CANNOT_SEND'` code is thrown when data
734-
cannot be sent on a socket.
723+
Used when data cannot be sent on a socket.
735724

736725
<a id="ERR_SOCKET_DGRAM_NOT_RUNNING"></a>
737726
### ERR_SOCKET_DGRAM_NOT_RUNNING
738727

739-
An error using the `'ERR_SOCKET_DGRAM_NOT_RUNNING'` code is thrown
740-
when a call is made and the UDP subsystem is not running.
728+
Used when a call is made and the UDP subsystem is not running.
741729

742730
<a id="ERR_STDERR_CLOSE"></a>
743731
### ERR_STDERR_CLOSE
744732

745-
An error using the `'ERR_STDERR_CLOSE'` code is thrown specifically when an
746-
attempt is made to close the `process.stderr` stream. By design, Node.js does
747-
not allow `stdout` or `stderr` Streams to be closed by user code.
733+
Used when an attempt is made to close the `process.stderr` stream. By design,
734+
Node.js does not allow `stdout` or `stderr` Streams to be closed by user code.
748735

749736
<a id="ERR_STDOUT_CLOSE"></a>
750737
### ERR_STDOUT_CLOSE
751738

752-
An error using the `'ERR_STDOUT_CLOSE'` code is thrown specifically when an
753-
attempt is made to close the `process.stdout` stream. By design, Node.js does
754-
not allow `stdout` or `stderr` Streams to be closed by user code.
739+
Used when an attempt is made to close the `process.stdout` stream. By design,
740+
Node.js does not allow `stdout` or `stderr` Streams to be closed by user code.
755741

756742
<a id="ERR_UNKNOWN_BUILTIN_MODULE"></a>
757743
### ERR_UNKNOWN_BUILTIN_MODULE
758744

759-
The `'ERR_UNKNOWN_BUILTIN_MODULE'` error code is used to identify a specific
760-
kind of internal Node.js error that should not typically be triggered by user
761-
code. Instances of this error point to an internal bug within the Node.js
762-
binary itself.
745+
Used to identify a specific kind of internal Node.js error that should not
746+
typically be triggered by user code. Instances of this error point to an
747+
internal bug within the Node.js binary itself.
763748

764749
<a id="ERR_UNKNOWN_SIGNAL"></a>
765750
### ERR_UNKNOWN_SIGNAL
766751

767-
The `'ERR_UNKNOWN_SIGNAL`' error code is used when an invalid or unknown
768-
process signal is passed to an API expecting a valid signal (such as
769-
[`child.kill()`][]).
752+
Used when an invalid or unknown process signal is passed to an API expecting a
753+
valid signal (such as [`child.kill()`][]).
770754

771755
<a id="ERR_UNKNOWN_STDIN_TYPE"></a>
772756
### ERR_UNKNOWN_STDIN_TYPE
773757

774-
An error using the `'ERR_UNKNOWN_STDIN_TYPE'` code is thrown specifically when
775-
an attempt is made to launch a Node.js process with an unknown `stdin` file
776-
type. Errors of this kind cannot *typically* be caused by errors in user code,
777-
although it is not impossible. Occurrences of this error are most likely an
778-
indication of a bug within Node.js itself.
758+
Used when an attempt is made to launch a Node.js process with an unknown `stdin`
759+
file type. Errors of this kind cannot *typically* be caused by errors in user
760+
code, although it is not impossible. Occurrences of this error are most likely
761+
an indication of a bug within Node.js itself.
779762

780763
<a id="ERR_UNKNOWN_STREAM_TYPE"></a>
781764
### ERR_UNKNOWN_STREAM_TYPE
782765

783-
An error using the `'ERR_UNKNOWN_STREAM_TYPE'` code is thrown specifically when
784-
an attempt is made to launch a Node.js process with an unknown `stdout` or
785-
`stderr` file type. Errors of this kind cannot *typically* be caused by errors
786-
in user code, although it is not impossible. Occurrences of this error are most
787-
likely an indication of a bug within Node.js itself.
766+
Used when an attempt is made to launch a Node.js process with an unknown
767+
`stdout` or `stderr` file type. Errors of this kind cannot *typically* be caused
768+
by errors in user code, although it is not impossible. Occurrences of this error
769+
are most likely an indication of a bug within Node.js itself.
788770

789771

790772
[`ERR_INVALID_ARG_TYPE`]: #ERR_INVALID_ARG_TYPE

0 commit comments

Comments
 (0)