Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2021-10-11 07:55:04 +0300
committerAntoine du Hamel <duhamelantoine1995@gmail.com>2021-10-20 12:59:11 +0300
commitd0b58c0287e67a139137aa906819d95f8314b093 (patch)
treee9a92870138d89b608b1c6e6568611744c32c4f2 /doc/api/errors.md
parenta7c17e08de658cbc0beefd8e9583803b5a62ac7e (diff)
doc: format doc/api/*.md with markdown formatter
PR-URL: https://github.com/nodejs/node/pull/40403 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Diffstat (limited to 'doc/api/errors.md')
-rw-r--r--doc/api/errors.md445
1 files changed, 426 insertions, 19 deletions
diff --git a/doc/api/errors.md b/doc/api/errors.md
index b0b0753f400..78106c93801 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -19,7 +19,7 @@ errors:
All JavaScript and system errors raised by Node.js inherit from, or are
instances of, the standard JavaScript {Error} class and are guaranteed
-to provide *at least* the properties available on that class.
+to provide _at least_ the properties available on that class.
## Error propagation and interception
@@ -30,7 +30,7 @@ occur while an application is running. How these errors are reported and
handled depends entirely on the type of `Error` and the style of the API that is
called.
-All JavaScript errors are handled as exceptions that *immediately* generate
+All JavaScript errors are handled as exceptions that _immediately_ generate
and throw an error using the standard JavaScript `throw` mechanism. These
are handled using the [`try…catch` construct][try-catch] provided by the
JavaScript language.
@@ -46,7 +46,7 @@ try {
```
Any use of the JavaScript `throw` mechanism will raise an exception that
-*must* be handled using `try…catch` or the Node.js process will exit
+_must_ be handled using `try…catch` or the Node.js process will exit
immediately.
With few exceptions, _Synchronous_ APIs (any blocking method that does not
@@ -60,7 +60,8 @@ Errors that occur within _Asynchronous APIs_ may be reported in multiple ways:
argument is not `null` and is an instance of `Error`, then an error occurred
that should be handled.
-<!-- eslint-disable no-useless-return -->
+ <!-- eslint-disable no-useless-return -->
+
```js
const fs = require('fs');
fs.readFile('a file that does not exist', (err, data) => {
@@ -101,7 +102,7 @@ and [event emitter-based][] APIs, which themselves represent a series of
asynchronous operations over time (as opposed to a single operation that may
pass or fail).
-For *all* [`EventEmitter`][] objects, if an `'error'` event handler is not
+For _all_ [`EventEmitter`][] objects, if an `'error'` event handler is not
provided, the error will be thrown, causing the Node.js process to report an
uncaught exception and crash unless either: The [`domain`][domains] module is
used appropriately or a handler has been registered for the
@@ -118,8 +119,8 @@ setImmediate(() => {
});
```
-Errors generated in this way *cannot* be intercepted using `try…catch` as
-they are thrown *after* the calling code has already exited.
+Errors generated in this way _cannot_ be intercepted using `try…catch` as
+they are thrown _after_ the calling code has already exited.
Developers must refer to the documentation for each method to determine
exactly how errors raised by those methods are propagated.
@@ -199,7 +200,7 @@ provided text message. If an object is passed as `message`, the text message
is generated by calling `message.toString()`. The `error.stack` property will
represent the point in the code at which `new Error()` was called. Stack traces
are dependent on [V8's stack trace API][]. Stack traces extend only to either
-(a) the beginning of *synchronous code execution*, or (b) the number of frames
+(a) the beginning of _synchronous code execution_, or (b) the number of frames
given by the property `Error.stackTraceLimit`, whichever is smaller.
### `Error.captureStackTrace(targetObject[, constructorOpt])`
@@ -247,7 +248,7 @@ collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).
The default value is `10` but may be set to any valid JavaScript number. Changes
-will affect any stack trace captured *after* the value has been changed.
+will affect any stack trace captured _after_ the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.
@@ -269,7 +270,7 @@ about specific codes.
The `error.message` property is the string description of the error as set by
calling `new Error(message)`. The `message` passed to the constructor will also
appear in the first line of the stack trace of the `Error`, however changing
-this property after the `Error` object is created *may not* change the first
+this property after the `Error` object is created _may not_ change the first
line of the stack trace (for example, when `error.stack` is read before this
property is changed).
@@ -341,7 +342,7 @@ The location information will be one of:
* `native`, if the frame represents a call internal to V8 (as in `[].forEach`).
* `plain-filename.js:line:column`, if the frame represents a call internal
- to Node.js.
+ to Node.js.
* `/absolute/path/to/file.js:line:column`, if the frame represents a call in
a user program, or its dependencies.
@@ -372,7 +373,7 @@ require('net').connect(-1);
// Throws "RangeError: "port" option should be >= 0 and < 65536: -1"
```
-Node.js will generate and throw `RangeError` instances *immediately* as a form
+Node.js will generate and throw `RangeError` instances _immediately_ as a form
of argument validation.
## Class: `ReferenceError`
@@ -570,7 +571,7 @@ require('url').parse(() => { });
// Throws TypeError, since it expected a string.
```
-Node.js will generate and throw `TypeError` instances *immediately* as a form
+Node.js will generate and throw `TypeError` instances _immediately_ as a form
of argument validation.
## Exceptions vs. errors
@@ -580,11 +581,11 @@ of argument validation.
A JavaScript exception is a value that is thrown as a result of an invalid
operation or as the target of a `throw` statement. While it is not required
that these values are instances of `Error` or classes which inherit from
-`Error`, all exceptions thrown by Node.js or the JavaScript runtime *will* be
+`Error`, all exceptions thrown by Node.js or the JavaScript runtime _will_ be
instances of `Error`.
-Some exceptions are *unrecoverable* at the JavaScript layer. Such exceptions
-will *always* cause the Node.js process to crash. Examples include `assert()`
+Some exceptions are _unrecoverable_ at the JavaScript layer. Such exceptions
+will _always_ cause the Node.js process to crash. Examples include `assert()`
checks or `abort()` calls in the C++ layer.
## OpenSSL errors
@@ -611,13 +612,17 @@ The OpenSSL library the error originates in.
A human-readable string describing the reason for the error.
<a id="nodejs-error-codes"></a>
+
## Node.js error codes
<a id="ABORT_ERR"></a>
+
### `ABORT_ERR`
+
<!-- YAML
added: v15.0.0
-->
+
Used when an operation has been aborted (typically using an `AbortController`).
APIs _not_ using `AbortSignal`s typically do not raise an error with this code.
@@ -626,6 +631,7 @@ This code does not use the regular `ERR_*` convention Node.js errors use in
order to be compatible with the web platform's `AbortError`.
<a id="ERR_AMBIGUOUS_ARGUMENT"></a>
+
### `ERR_AMBIGUOUS_ARGUMENT`
A function argument is being used in a way that suggests that the function
@@ -636,12 +642,14 @@ is the expected message rather than the message the `AssertionError` will
display if `block` does not throw.
<a id="ERR_ARG_NOT_ITERABLE"></a>
+
### `ERR_ARG_NOT_ITERABLE`
An iterable argument (i.e. a value that works with `for...of` loops) was
required, but not provided to a Node.js API.
<a id="ERR_ASSERTION"></a>
+
### `ERR_ASSERTION`
A special type of error that can be triggered whenever Node.js detects an
@@ -649,28 +657,33 @@ exceptional logic violation that should never occur. These are raised typically
by the `assert` module.
<a id="ERR_ASYNC_CALLBACK"></a>
+
### `ERR_ASYNC_CALLBACK`
An attempt was made to register something that is not a function as an
`AsyncHooks` callback.
<a id="ERR_ASYNC_TYPE"></a>
+
### `ERR_ASYNC_TYPE`
The type of an asynchronous resource was invalid. Users are also able
to define their own types if using the public embedder API.
<a id="ERR_BROTLI_COMPRESSION_FAILED"></a>
+
### `ERR_BROTLI_COMPRESSION_FAILED`
Data passed to a Brotli stream was not successfully compressed.
<a id="ERR_BROTLI_INVALID_PARAM"></a>
+
### `ERR_BROTLI_INVALID_PARAM`
An invalid parameter key was passed during construction of a Brotli stream.
<a id="ERR_BUFFER_CONTEXT_NOT_AVAILABLE"></a>
+
### `ERR_BUFFER_CONTEXT_NOT_AVAILABLE`
An attempt was made to create a Node.js `Buffer` instance from addon or embedder
@@ -684,39 +697,47 @@ prototype of the resulting object. `Uint8Array`s are generally accepted in all
Node.js core APIs where `Buffer`s are; they are available in all Contexts.
<a id="ERR_BUFFER_OUT_OF_BOUNDS"></a>
+
### `ERR_BUFFER_OUT_OF_BOUNDS`
An operation outside the bounds of a `Buffer` was attempted.
<a id="ERR_BUFFER_TOO_LARGE"></a>
+
### `ERR_BUFFER_TOO_LARGE`
An attempt has been made to create a `Buffer` larger than the maximum allowed
size.
<a id="ERR_CANNOT_WATCH_SIGINT"></a>
+
### `ERR_CANNOT_WATCH_SIGINT`
Node.js was unable to watch for the `SIGINT` signal.
<a id="ERR_CHILD_CLOSED_BEFORE_REPLY"></a>
+
### `ERR_CHILD_CLOSED_BEFORE_REPLY`
A child process was closed before the parent received a reply.
<a id="ERR_CHILD_PROCESS_IPC_REQUIRED"></a>
+
### `ERR_CHILD_PROCESS_IPC_REQUIRED`
Used when a child process is being forked without specifying an IPC channel.
<a id="ERR_CHILD_PROCESS_STDIO_MAXBUFFER"></a>
+
### `ERR_CHILD_PROCESS_STDIO_MAXBUFFER`
Used when the main process is trying to read data from the child process's
STDERR/STDOUT, and the data's length is longer than the `maxBuffer` option.
<a id="ERR_CLOSED_MESSAGE_PORT"></a>
+
### `ERR_CLOSED_MESSAGE_PORT`
+
<!--
added:
- v16.2.0
@@ -736,13 +757,16 @@ There was an attempt to use a `MessagePort` instance in a closed
state, usually after `.close()` has been called.
<a id="ERR_CONSOLE_WRITABLE_STREAM"></a>
+
### `ERR_CONSOLE_WRITABLE_STREAM`
`Console` was instantiated without `stdout` stream, or `Console` has a
non-writable `stdout` or `stderr` stream.
<a id="ERR_CONSTRUCT_CALL_INVALID"></a>
+
### `ERR_CONSTRUCT_CALL_INVALID`
+
<!--
added: v12.5.0
-->
@@ -750,11 +774,13 @@ added: v12.5.0
A class constructor was called that is not callable.
<a id="ERR_CONSTRUCT_CALL_REQUIRED"></a>
+
### `ERR_CONSTRUCT_CALL_REQUIRED`
A constructor for a class was called without `new`.
<a id="ERR_CONTEXT_NOT_INITIALIZED"></a>
+
### `ERR_CONTEXT_NOT_INITIALIZED`
The vm context passed into the API is not yet initialized. This could happen
@@ -763,18 +789,21 @@ context, for example, when the allocation fails or the maximum call stack
size is reached when the context is created.
<a id="ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED"></a>
+
### `ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED`
A client certificate engine was requested that is not supported by the version
of OpenSSL being used.
<a id="ERR_CRYPTO_ECDH_INVALID_FORMAT"></a>
+
### `ERR_CRYPTO_ECDH_INVALID_FORMAT`
An invalid value for the `format` argument was passed to the `crypto.ECDH()`
class `getPublicKey()` method.
<a id="ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY"></a>
+
### `ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY`
An invalid value for the `key` argument has been passed to the
@@ -782,46 +811,55 @@ An invalid value for the `key` argument has been passed to the
key lies outside of the elliptic curve.
<a id="ERR_CRYPTO_ENGINE_UNKNOWN"></a>
+
### `ERR_CRYPTO_ENGINE_UNKNOWN`
An invalid crypto engine identifier was passed to
[`require('crypto').setEngine()`][].
<a id="ERR_CRYPTO_FIPS_FORCED"></a>
+
### `ERR_CRYPTO_FIPS_FORCED`
The [`--force-fips`][] command-line argument was used but there was an attempt
to enable or disable FIPS mode in the `crypto` module.
<a id="ERR_CRYPTO_FIPS_UNAVAILABLE"></a>
+
### `ERR_CRYPTO_FIPS_UNAVAILABLE`
An attempt was made to enable or disable FIPS mode, but FIPS mode was not
available.
<a id="ERR_CRYPTO_HASH_FINALIZED"></a>
+
### `ERR_CRYPTO_HASH_FINALIZED`
[`hash.digest()`][] was called multiple times. The `hash.digest()` method must
be called no more than one time per instance of a `Hash` object.
<a id="ERR_CRYPTO_HASH_UPDATE_FAILED"></a>
+
### `ERR_CRYPTO_HASH_UPDATE_FAILED`
[`hash.update()`][] failed for any reason. This should rarely, if ever, happen.
<a id="ERR_CRYPTO_INCOMPATIBLE_KEY"></a>
+
### `ERR_CRYPTO_INCOMPATIBLE_KEY`
The given crypto keys are incompatible with the attempted operation.
<a id="ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS"></a>
+
### `ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS`
The selected public or private key encoding is incompatible with other options.
<a id="ERR_CRYPTO_INITIALIZATION_FAILED"></a>
+
### `ERR_CRYPTO_INITIALIZATION_FAILED`
+
<!-- YAML
added: v15.0.0
-->
@@ -829,7 +867,9 @@ added: v15.0.0
Initialization of the crypto subsystem failed.
<a id="ERR_CRYPTO_INVALID_AUTH_TAG"></a>
+
### `ERR_CRYPTO_INVALID_AUTH_TAG`
+
<!-- YAML
added: v15.0.0
-->
@@ -837,7 +877,9 @@ added: v15.0.0
An invalid authentication tag was provided.
<a id="ERR_CRYPTO_INVALID_COUNTER"></a>
+
### `ERR_CRYPTO_INVALID_COUNTER`
+
<!-- YAML
added: v15.0.0
-->
@@ -845,7 +887,9 @@ added: v15.0.0
An invalid counter was provided for a counter-mode cipher.
<a id="ERR_CRYPTO_INVALID_CURVE"></a>
+
### `ERR_CRYPTO_INVALID_CURVE`
+
<!-- YAML
added: v15.0.0
-->
@@ -853,12 +897,15 @@ added: v15.0.0
An invalid elliptic-curve was provided.
<a id="ERR_CRYPTO_INVALID_DIGEST"></a>
+
### `ERR_CRYPTO_INVALID_DIGEST`
An invalid [crypto digest algorithm][] was specified.
<a id="ERR_CRYPTO_INVALID_IV"></a>
+
### `ERR_CRYPTO_INVALID_IV`
+
<!-- YAML
added: v15.0.0
-->
@@ -866,7 +913,9 @@ added: v15.0.0
An invalid initialization vector was provided.
<a id="ERR_CRYPTO_INVALID_JWK"></a>
+
### `ERR_CRYPTO_INVALID_JWK`
+
<!-- YAML
added: v15.0.0
-->
@@ -874,12 +923,15 @@ added: v15.0.0
An invalid JSON Web Key was provided.
<a id="ERR_CRYPTO_INVALID_KEY_OBJECT_TYPE"></a>
+
### `ERR_CRYPTO_INVALID_KEY_OBJECT_TYPE`
The given crypto key object's type is invalid for the attempted operation.
<a id="ERR_CRYPTO_INVALID_KEYLEN"></a>
+
### `ERR_CRYPTO_INVALID_KEYLEN`
+
<!-- YAML
added: v15.0.0
-->
@@ -887,7 +939,9 @@ added: v15.0.0
An invalid key length was provided.
<a id="ERR_CRYPTO_INVALID_KEYPAIR"></a>
+
### `ERR_CRYPTO_INVALID_KEYPAIR`
+
<!-- YAML
added: v15.0.0
-->
@@ -895,7 +949,9 @@ added: v15.0.0
An invalid key pair was provided.
<a id="ERR_CRYPTO_INVALID_KEYTYPE"></a>
+
### `ERR_CRYPTO_INVALID_KEYTYPE`
+
<!-- YAML
added: v15.0.0
-->
@@ -903,7 +959,9 @@ added: v15.0.0
An invalid key type was provided.
<a id="ERR_CRYPTO_INVALID_MESSAGELEN"></a>
+
### `ERR_CRYPTO_INVALID_MESSAGELEN`
+
<!-- YAML
added: v15.0.0
-->
@@ -911,7 +969,9 @@ added: v15.0.0
An invalid message length was provided.
<a id="ERR_CRYPTO_INVALID_SCRYPT_PARAMS"></a>
+
### `ERR_CRYPTO_INVALID_SCRYPT_PARAMS`
+
<!-- YAML
added: v15.0.0
-->
@@ -919,13 +979,16 @@ added: v15.0.0
Invalid scrypt algorithm parameters were provided.
<a id="ERR_CRYPTO_INVALID_STATE"></a>
+
### `ERR_CRYPTO_INVALID_STATE`
A crypto method was used on an object that was in an invalid state. For
instance, calling [`cipher.getAuthTag()`][] before calling `cipher.final()`.
<a id="ERR_CRYPTO_INVALID_TAG_LENGTH"></a>
+
### `ERR_CRYPTO_INVALID_TAG_LENGTH`
+
<!-- YAML
added: v15.0.0
-->
@@ -933,7 +996,9 @@ added: v15.0.0
An invalid authentication tag length was provided.
<a id="ERR_CRYPTO_JOB_INIT_FAILED"></a>
+
### `ERR_CRYPTO_JOB_INIT_FAILED`
+
<!-- YAML
added: v15.0.0
-->
@@ -941,19 +1006,23 @@ added: v15.0.0
Initialization of an asynchronous crypto operation failed.
<a id="ERR_CRYPTO_JWK_UNSUPPORTED_CURVE"></a>
+
### `ERR_CRYPTO_JWK_UNSUPPORTED_CURVE`
Key's Elliptic Curve is not registered for use in the
[JSON Web Key Elliptic Curve Registry][].
<a id="ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE"></a>
+
### `ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE`
Key's Asymmetric Key Type is not registered for use in the
[JSON Web Key Types Registry][].
<a id="ERR_CRYPTO_OPERATION_FAILED"></a>
+
### `ERR_CRYPTO_OPERATION_FAILED`
+
<!-- YAML
added: v15.0.0
-->
@@ -961,47 +1030,56 @@ added: v15.0.0
A crypto operation failed for an otherwise unspecified reason.
<a id="ERR_CRYPTO_PBKDF2_ERROR"></a>
+
### `ERR_CRYPTO_PBKDF2_ERROR`
The PBKDF2 algorithm failed for unspecified reasons. OpenSSL does not provide
more details and therefore neither does Node.js.
<a id="ERR_CRYPTO_SCRYPT_INVALID_PARAMETER"></a>
+
### `ERR_CRYPTO_SCRYPT_INVALID_PARAMETER`
One or more [`crypto.scrypt()`][] or [`crypto.scryptSync()`][] parameters are
outside their legal range.
<a id="ERR_CRYPTO_SCRYPT_NOT_SUPPORTED"></a>
+
### `ERR_CRYPTO_SCRYPT_NOT_SUPPORTED`
Node.js was compiled without `scrypt` support. Not possible with the official
release binaries but can happen with custom builds, including distro builds.
<a id="ERR_CRYPTO_SIGN_KEY_REQUIRED"></a>
+
### `ERR_CRYPTO_SIGN_KEY_REQUIRED`
A signing `key` was not provided to the [`sign.sign()`][] method.
<a id="ERR_CRYPTO_TIMING_SAFE_EQUAL_LENGTH"></a>
+
### `ERR_CRYPTO_TIMING_SAFE_EQUAL_LENGTH`
[`crypto.timingSafeEqual()`][] was called with `Buffer`, `TypedArray`, or
`DataView` arguments of different lengths.
<a id="ERR_CRYPTO_UNKNOWN_CIPHER"></a>
+
### `ERR_CRYPTO_UNKNOWN_CIPHER`
An unknown cipher was specified.
<a id="ERR_CRYPTO_UNKNOWN_DH_GROUP"></a>
+
### `ERR_CRYPTO_UNKNOWN_DH_GROUP`
An unknown Diffie-Hellman group name was given. See
[`crypto.getDiffieHellman()`][] for a list of valid group names.
<a id="ERR_CRYPTO_UNSUPPORTED_OPERATION"></a>
+
### `ERR_CRYPTO_UNSUPPORTED_OPERATION`
+
<!-- YAML
added:
- v15.0.0
@@ -1011,7 +1089,9 @@ added:
An attempt to invoke an unsupported crypto operation was made.
<a id="ERR_DEBUGGER_ERROR"></a>
+
### `ERR_DEBUGGER_ERROR`
+
<!-- YAML
added:
- v16.4.0
@@ -1021,7 +1101,9 @@ added:
An error occurred with the [debugger][].
<a id="ERR_DEBUGGER_STARTUP_ERROR"></a>
+
### `ERR_DEBUGGER_STARTUP_ERROR`
+
<!-- YAML
added:
- v16.4.0
@@ -1031,7 +1113,9 @@ added:
The [debugger][] timed out waiting for the required host/port to be free.
<a id="ERR_DLOPEN_DISABLED"></a>
+
### `ERR_DLOPEN_DISABLED`
+
<!-- YAML
added: v16.10.0
-->
@@ -1039,7 +1123,9 @@ added: v16.10.0
Loading native addons has been disabled using [`--no-addons`][].
<a id="ERR_DLOPEN_FAILED"></a>
+
### `ERR_DLOPEN_FAILED`
+
<!-- YAML
added: v15.0.0
-->
@@ -1047,12 +1133,15 @@ added: v15.0.0
A call to `process.dlopen()` failed.
<a id="ERR_DIR_CLOSED"></a>
+
### `ERR_DIR_CLOSED`
The [`fs.Dir`][] was previously closed.
<a id="ERR_DIR_CONCURRENT_OPERATION"></a>
+
### `ERR_DIR_CONCURRENT_OPERATION`
+
<!-- YAML
added: v14.3.0
-->
@@ -1061,11 +1150,13 @@ A synchronous read or close call was attempted on an [`fs.Dir`][] which has
ongoing asynchronous operations.
<a id="ERR_DNS_SET_SERVERS_FAILED"></a>
+
### `ERR_DNS_SET_SERVERS_FAILED`
`c-ares` failed to set the DNS server.
<a id="ERR_DOMAIN_CALLBACK_NOT_AVAILABLE"></a>
+
### `ERR_DOMAIN_CALLBACK_NOT_AVAILABLE`
The `domain` module was not usable since it could not establish the required
@@ -1074,6 +1165,7 @@ error handling hooks, because
earlier point in time.
<a id="ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE"></a>
+
### `ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`
[`process.setUncaughtExceptionCaptureCallback()`][] could not be called
@@ -1083,28 +1175,33 @@ The stack trace is extended to include the point in time at which the
`domain` module had been loaded.
<a id="ERR_ENCODING_INVALID_ENCODED_DATA"></a>
+
### `ERR_ENCODING_INVALID_ENCODED_DATA`
Data provided to `TextDecoder()` API was invalid according to the encoding
provided.
<a id="ERR_ENCODING_NOT_SUPPORTED"></a>
+
### `ERR_ENCODING_NOT_SUPPORTED`
Encoding provided to `TextDecoder()` API was not one of the
[WHATWG Supported Encodings][].
<a id="ERR_EVAL_ESM_CANNOT_PRINT"></a>
+
### `ERR_EVAL_ESM_CANNOT_PRINT`
`--print` cannot be used with ESM input.
<a id="ERR_EVENT_RECURSION"></a>
+
### `ERR_EVENT_RECURSION`
Thrown when an attempt is made to recursively dispatch an event on `EventTarget`.
<a id="ERR_EXECUTION_ENVIRONMENT_NOT_AVAILABLE"></a>
+
### `ERR_EXECUTION_ENVIRONMENT_NOT_AVAILABLE`
The JS execution context is not associated with a Node.js environment.
@@ -1112,13 +1209,16 @@ This may occur when Node.js is used as an embedded library and some hooks
for the JS engine are not set up properly.
<a id="ERR_FALSY_VALUE_REJECTION"></a>
+
### `ERR_FALSY_VALUE_REJECTION`
A `Promise` that was callbackified via `util.callbackify()` was rejected with a
falsy value.
<a id="ERR_FEATURE_UNAVAILABLE_ON_PLATFORM"></a>
+
### `ERR_FEATURE_UNAVAILABLE_ON_PLATFORM`
+
<!-- YAML
added: v14.0.0
-->
@@ -1127,7 +1227,9 @@ Used when a feature that is not available
to the current platform which is running Node.js is used.
<a id="ERR_FS_CP_DIR_TO_NON_DIR"></a>
+
### `ERR_FS_CP_DIR_TO_NON_DIR`
+
<!--
added: v16.7.0
-->
@@ -1136,7 +1238,9 @@ An attempt was made to copy a directory to a non-directory (file, symlink,
etc.) using [`fs.cp()`][].
<a id="ERR_FS_CP_EEXIST"></a>
+
### `ERR_FS_CP_EEXIST`
+
<!--
added: v16.7.0
-->
@@ -1145,7 +1249,9 @@ An attempt was made to copy over a file that already existed with
[`fs.cp()`][], with the `force` and `errorOnExist` set to `true`.
<a id="ERR_FS_CP_EINVAL"></a>
+
### `ERR_FS_CP_EINVAL`
+
<!--
added: v16.7.0
-->
@@ -1153,7 +1259,9 @@ added: v16.7.0
When using [`fs.cp()`][], `src` or `dest` pointed to an invalid path.
<a id="ERR_FS_CP_FIFO_PIPE"></a>
+
### `ERR_FS_CP_FIFO_PIPE`
+
<!--
added: v16.7.0
-->
@@ -1161,7 +1269,9 @@ added: v16.7.0
An attempt was made to copy a named pipe with [`fs.cp()`][].
<a id="ERR_FS_CP_NON_DIR_TO_DIR"></a>
+
### `ERR_FS_CP_NON_DIR_TO_DIR`
+
<!--
added: v16.7.0
-->
@@ -1170,7 +1280,9 @@ An attempt was made to copy a non-directory (file, symlink, etc.) to a directory
using [`fs.cp()`][].
<a id="ERR_FS_CP_SOCKET"></a>
+
### `ERR_FS_CP_SOCKET`
+
<!--
added: v16.7.0
-->
@@ -1178,7 +1290,9 @@ added: v16.7.0
An attempt was made to copy to a socket with [`fs.cp()`][].
<a id="ERR_FS_CP_SYMLINK_TO_SUBDIRECTORY"></a>
+
### `ERR_FS_CP_SYMLINK_TO_SUBDIRECTORY`
+
<!--
added: v16.7.0
-->
@@ -1187,7 +1301,9 @@ When using [`fs.cp()`][], a symlink in `dest` pointed to a subdirectory
of `src`.
<a id="ERR_FS_CP_UNKNOWN"></a>
+
### `ERR_FS_CP_UNKNOWN`
+
<!--
added: v16.7.0
-->
@@ -1195,137 +1311,162 @@ added: v16.7.0
An attempt was made to copy to an unknown file type with [`fs.cp()`][].
<a id="ERR_FS_EISDIR"></a>
+
### `ERR_FS_EISDIR`
Path is a directory.
<a id="ERR_FS_FILE_TOO_LARGE"></a>
+
### `ERR_FS_FILE_TOO_LARGE`
An attempt has been made to read a file whose size is larger than the maximum
allowed size for a `Buffer`.
<a id="ERR_FS_INVALID_SYMLINK_TYPE"></a>
+
### `ERR_FS_INVALID_SYMLINK_TYPE`
An invalid symlink type was passed to the [`fs.symlink()`][] or
[`fs.symlinkSync()`][] methods.
<a id="ERR_HTTP_HEADERS_SENT"></a>
+
### `ERR_HTTP_HEADERS_SENT`
An attempt was made to add more headers after the headers had already been sent.
<a id="ERR_HTTP_INVALID_HEADER_VALUE"></a>
+
### `ERR_HTTP_INVALID_HEADER_VALUE`
An invalid HTTP header value was specified.
<a id="ERR_HTTP_INVALID_STATUS_CODE"></a>
+
### `ERR_HTTP_INVALID_STATUS_CODE`
Status code was outside the regular status code range (100-999).
<a id="ERR_HTTP_REQUEST_TIMEOUT"></a>
+
### `ERR_HTTP_REQUEST_TIMEOUT`
The client has not sent the entire request within the allowed time.
<a id="ERR_HTTP_SOCKET_ENCODING"></a>
+
### `ERR_HTTP_SOCKET_ENCODING`
Changing the socket encoding is not allowed per [RFC 7230 Section 3][].
<a id="ERR_HTTP_TRAILER_INVALID"></a>
+
### `ERR_HTTP_TRAILER_INVALID`
The `Trailer` header was set even though the transfer encoding does not support
that.
<a id="ERR_HTTP2_ALTSVC_INVALID_ORIGIN"></a>
+
### `ERR_HTTP2_ALTSVC_INVALID_ORIGIN`
HTTP/2 ALTSVC frames require a valid origin.
<a id="ERR_HTTP2_ALTSVC_LENGTH"></a>
+
### `ERR_HTTP2_ALTSVC_LENGTH`
HTTP/2 ALTSVC frames are limited to a maximum of 16,382 payload bytes.
<a id="ERR_HTTP2_CONNECT_AUTHORITY"></a>
+
### `ERR_HTTP2_CONNECT_AUTHORITY`
For HTTP/2 requests using the `CONNECT` method, the `:authority` pseudo-header
is required.
<a id="ERR_HTTP2_CONNECT_PATH"></a>
+
### `ERR_HTTP2_CONNECT_PATH`
For HTTP/2 requests using the `CONNECT` method, the `:path` pseudo-header is
forbidden.
<a id="ERR_HTTP2_CONNECT_SCHEME"></a>
+
### `ERR_HTTP2_CONNECT_SCHEME`
For HTTP/2 requests using the `CONNECT` method, the `:scheme` pseudo-header is
forbidden.
<a id="ERR_HTTP2_ERROR"></a>
+
### `ERR_HTTP2_ERROR`
A non-specific HTTP/2 error has occurred.
<a id="ERR_HTTP2_GOAWAY_SESSION"></a>
+
### `ERR_HTTP2_GOAWAY_SESSION`
New HTTP/2 Streams may not be opened after the `Http2Session` has received a
`GOAWAY` frame from the connected peer.
<a id="ERR_HTTP2_HEADER_SINGLE_VALUE"></a>
+
### `ERR_HTTP2_HEADER_SINGLE_VALUE`
Multiple values were provided for an HTTP/2 header field that was required to
have only a single value.
<a id="ERR_HTTP2_HEADERS_AFTER_RESPOND"></a>
+
### `ERR_HTTP2_HEADERS_AFTER_RESPOND`
An additional headers was specified after an HTTP/2 response was initiated.
<a id="ERR_HTTP2_HEADERS_SENT"></a>
+
### `ERR_HTTP2_HEADERS_SENT`
An attempt was made to send multiple response headers.
<a id="ERR_HTTP2_INFO_STATUS_NOT_ALLOWED"></a>
+
### `ERR_HTTP2_INFO_STATUS_NOT_ALLOWED`
Informational HTTP status codes (`1xx`) may not be set as the response status
code on HTTP/2 responses.
<a id="ERR_HTTP2_INVALID_CONNECTION_HEADERS"></a>
+
### `ERR_HTTP2_INVALID_CONNECTION_HEADERS`
HTTP/1 connection specific headers are forbidden to be used in HTTP/2
requests and responses.
<a id="ERR_HTTP2_INVALID_HEADER_VALUE"></a>
+
### `ERR_HTTP2_INVALID_HEADER_VALUE`
An invalid HTTP/2 header value was specified.
<a id="ERR_HTTP2_INVALID_INFO_STATUS"></a>
+
### `ERR_HTTP2_INVALID_INFO_STATUS`
An invalid HTTP informational status code has been specified. Informational
status codes must be an integer between `100` and `199` (inclusive).
<a id="ERR_HTTP2_INVALID_ORIGIN"></a>
+
### `ERR_HTTP2_INVALID_ORIGIN`
HTTP/2 `ORIGIN` frames require a valid origin.
<a id="ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH"></a>
+
### `ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH`
Input `Buffer` and `Uint8Array` instances passed to the
@@ -1333,28 +1474,33 @@ Input `Buffer` and `Uint8Array` instances passed to the
six.
<a id="ERR_HTTP2_INVALID_PSEUDOHEADER"></a>
+
### `ERR_HTTP2_INVALID_PSEUDOHEADER`
Only valid HTTP/2 pseudoheaders (`:status`, `:path`, `:authority`, `:scheme`,
and `:method`) may be used.
<a id="ERR_HTTP2_INVALID_SESSION"></a>
+
### `ERR_HTTP2_INVALID_SESSION`
An action was performed on an `Http2Session` object that had already been
destroyed.
<a id="ERR_HTTP2_INVALID_SETTING_VALUE"></a>
+
### `ERR_HTTP2_INVALID_SETTING_VALUE`
An invalid value has been specified for an HTTP/2 setting.
<a id="ERR_HTTP2_INVALID_STREAM"></a>
+
### `ERR_HTTP2_INVALID_STREAM`
An operation was performed on a stream that had already been destroyed.
<a id="ERR_HTTP2_MAX_PENDING_SETTINGS_ACK"></a>
+
### `ERR_HTTP2_MAX_PENDING_SETTINGS_ACK`
Whenever an HTTP/2 `SETTINGS` frame is sent to a connected peer, the peer is
@@ -1364,68 +1510,80 @@ be sent at any given time. This error code is used when that limit has been
reached.
<a id="ERR_HTTP2_NESTED_PUSH"></a>
+
### `ERR_HTTP2_NESTED_PUSH`
An attempt was made to initiate a new push stream from within a push stream.
Nested push streams are not permitted.
<a id="ERR_HTTP2_NO_MEM"></a>
+
### `ERR_HTTP2_NO_MEM`
Out of memory when using the `http2session.setLocalWindowSize(windowSize)` API.
<a id="ERR_HTTP2_NO_SOCKET_MANIPULATION"></a>
+
### `ERR_HTTP2_NO_SOCKET_MANIPULATION`
An attempt was made to directly manipulate (read, write, pause, resume, etc.) a
socket attached to an `Http2Session`.
<a id="ERR_HTTP2_ORIGIN_LENGTH"></a>
+
### `ERR_HTTP2_ORIGIN_LENGTH`
HTTP/2 `ORIGIN` frames are limited to a length of 16382 bytes.
<a id="ERR_HTTP2_OUT_OF_STREAMS"></a>
+
### `ERR_HTTP2_OUT_OF_STREAMS`
The number of streams created on a single HTTP/2 session reached the maximum
limit.
<a id="ERR_HTTP2_PAYLOAD_FORBIDDEN"></a>
+
### `ERR_HTTP2_PAYLOAD_FORBIDDEN`
A message payload was specified for an HTTP response code for which a payload is
forbidden.
<a id="ERR_HTTP2_PING_CANCEL"></a>
+
### `ERR_HTTP2_PING_CANCEL`
An HTTP/2 ping was canceled.
<a id="ERR_HTTP2_PING_LENGTH"></a>
+
### `ERR_HTTP2_PING_LENGTH`
HTTP/2 ping payloads must be exactly 8 bytes in length.
<a id="ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED"></a>
+
### `ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`
An HTTP/2 pseudo-header has been used inappropriately. Pseudo-headers are header
key names that begin with the `:` prefix.
<a id="ERR_HTTP2_PUSH_DISABLED"></a>
+
### `ERR_HTTP2_PUSH_DISABLED`
An attempt was made to create a push stream, which had been disabled by the
client.
<a id="ERR_HTTP2_SEND_FILE"></a>
+
### `ERR_HTTP2_SEND_FILE`
An attempt was made to use the `Http2Stream.prototype.responseWithFile()` API to
send a directory.
<a id="ERR_HTTP2_SEND_FILE_NOSEEK"></a>
+
### `ERR_HTTP2_SEND_FILE_NOSEEK`
An attempt was made to use the `Http2Stream.prototype.responseWithFile()` API to
@@ -1433,50 +1591,59 @@ send something other than a regular file, but `offset` or `length` options were
provided.
<a id="ERR_HTTP2_SESSION_ERROR"></a>
+
### `ERR_HTTP2_SESSION_ERROR`
The `Http2Session` closed with a non-zero error code.
<a id="ERR_HTTP2_SETTINGS_CANCEL"></a>
+
### `ERR_HTTP2_SETTINGS_CANCEL`
The `Http2Session` settings canceled.
<a id="ERR_HTTP2_SOCKET_BOUND"></a>
+
### `ERR_HTTP2_SOCKET_BOUND`
An attempt was made to connect a `Http2Session` object to a `net.Socket` or
`tls.TLSSocket` that had already been bound to another `Http2Session` object.
<a id="ERR_HTTP2_SOCKET_UNBOUND"></a>
+
### `ERR_HTTP2_SOCKET_UNBOUND`
An attempt was made to use the `socket` property of an `Http2Session` that
has already been closed.
<a id="ERR_HTTP2_STATUS_101"></a>
+
### `ERR_HTTP2_STATUS_101`
Use of the `101` Informational status code is forbidden in HTTP/2.
<a id="ERR_HTTP2_STATUS_INVALID"></a>
+
### `ERR_HTTP2_STATUS_INVALID`
An invalid HTTP status code has been specified. Status codes must be an integer
between `100` and `599` (inclusive).
<a id="ERR_HTTP2_STREAM_CANCEL"></a>
+
### `ERR_HTTP2_STREAM_CANCEL`
An `Http2Stream` was destroyed before any data was transmitted to the connected
peer.
<a id="ERR_HTTP2_STREAM_ERROR"></a>
+
### `ERR_HTTP2_STREAM_ERROR`
A non-zero error code was been specified in an `RST_STREAM` frame.
<a id="ERR_HTTP2_STREAM_SELF_DEPENDENCY"></a>
+
### `ERR_HTTP2_STREAM_SELF_DEPENDENCY`
When setting the priority for an HTTP/2 stream, the stream may be marked as
@@ -1484,7 +1651,9 @@ a dependency for a parent stream. This error code is used when an attempt is
made to mark a stream and dependent of itself.
<a id="ERR_HTTP2_TOO_MANY_INVALID_FRAMES"></a>
+
### `ERR_HTTP2_TOO_MANY_INVALID_FRAMES`
+
<!--
added: v15.14.0
-->
@@ -1493,11 +1662,13 @@ The limit of acceptable invalid HTTP/2 protocol frames sent by the peer,
as specified through the `maxSessionInvalidFrames` option, has been exceeded.
<a id="ERR_HTTP2_TRAILERS_ALREADY_SENT"></a>
+
### `ERR_HTTP2_TRAILERS_ALREADY_SENT`
Trailing headers have already been sent on the `Http2Stream`.
<a id="ERR_HTTP2_TRAILERS_NOT_READY"></a>
+
### `ERR_HTTP2_TRAILERS_NOT_READY`
The `http2stream.sendTrailers()` method cannot be called until after the
@@ -1506,23 +1677,27 @@ The `http2stream.sendTrailers()` method cannot be called until after the
is set for the `Http2Stream`.
<a id="ERR_HTTP2_UNSUPPORTED_PROTOCOL"></a>
+
### `ERR_HTTP2_UNSUPPORTED_PROTOCOL`
`http2.connect()` was passed a URL that uses any protocol other than `http:` or
`https:`.
<a id="ERR_ILLEGAL_CONSTRUCTOR"></a>
+
### `ERR_ILLEGAL_CONSTRUCTOR`
An attempt was made to construct an object using a non-public constructor.
<a id="ERR_INCOMPATIBLE_OPTION_PAIR"></a>
+
### `ERR_INCOMPATIBLE_OPTION_PAIR`
An option pair is incompatible with each other and cannot be used at the same
time.
<a id="ERR_INPUT_TYPE_NOT_ALLOWED"></a>
+
### `ERR_INPUT_TYPE_NOT_ALLOWED`
> Stability: 1 - Experimental
@@ -1531,6 +1706,7 @@ The `--input-type` flag was used to attempt to execute a file. This flag can
only be used with input via `--eval`, `--print` or `STDIN`.
<a id="ERR_INSPECTOR_ALREADY_ACTIVATED"></a>
+
### `ERR_INSPECTOR_ALREADY_ACTIVATED`
While using the `inspector` module, an attempt was made to activate the
@@ -1538,104 +1714,123 @@ inspector when it already started to listen on a port. Use `inspector.close()`
before activating it on a different address.
<a id="ERR_INSPECTOR_ALREADY_CONNECTED"></a>
+
### `ERR_INSPECTOR_ALREADY_CONNECTED`
While using the `inspector` module, an attempt was made to connect when the
inspector was already connected.
<a id="ERR_INSPECTOR_CLOSED"></a>
+
### `ERR_INSPECTOR_CLOSED`
While using the `inspector` module, an attempt was made to use the inspector
after the session had already closed.
<a id="ERR_INSPECTOR_COMMAND"></a>
+
### `ERR_INSPECTOR_COMMAND`
An error occurred while issuing a command via the `inspector` module.
<a id="ERR_INSPECTOR_NOT_ACTIVE"></a>
+
### `ERR_INSPECTOR_NOT_ACTIVE`
The `inspector` is not active when `inspector.waitForDebugger()` is called.
<a id="ERR_INSPECTOR_NOT_AVAILABLE"></a>
+
### `ERR_INSPECTOR_NOT_AVAILABLE`
The `inspector` module is not available for use.
<a id="ERR_INSPECTOR_NOT_CONNECTED"></a>
+
### `ERR_INSPECTOR_NOT_CONNECTED`
While using the `inspector` module, an attempt was made to use the inspector
before it was connected.
<a id="ERR_INSPECTOR_NOT_WORKER"></a>
+
### `ERR_INSPECTOR_NOT_WORKER`
An API was called on the main thread that can only be used from
the worker thread.
<a id="ERR_INTERNAL_ASSERTION"></a>
+
### `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 <https://github.com/nodejs/node/issues>.
<a id="ERR_INVALID_ADDRESS_FAMILY"></a>
+
### `ERR_INVALID_ADDRESS_FAMILY`
The provided address family is not understood by the Node.js API.
<a id="ERR_INVALID_ARG_TYPE"></a>
+
### `ERR_INVALID_ARG_TYPE`
An argument of the wrong type was passed to a Node.js API.
<a id="ERR_INVALID_ARG_VALUE"></a>
+
### `ERR_INVALID_ARG_VALUE`
An invalid or unsupported value was passed for a given argument.
<a id="ERR_INVALID_ASYNC_ID"></a>
+
### `ERR_INVALID_ASYNC_ID`
An invalid `asyncId` or `triggerAsyncId` was passed using `AsyncHooks`. An id
less than -1 should never happen.
<a id="ERR_INVALID_BUFFER_SIZE"></a>
+
### `ERR_INVALID_BUFFER_SIZE`
A swap was performed on a `Buffer` but its size was not compatible with the
operation.
<a id="ERR_INVALID_CALLBACK"></a>
+
### `ERR_INVALID_CALLBACK`
A callback function was required but was not been provided to a Node.js API.
<a id="ERR_INVALID_CHAR"></a>
+
### `ERR_INVALID_CHAR`
Invalid characters were detected in headers.
<a id="ERR_INVALID_CURSOR_POS"></a>
+
### `ERR_INVALID_CURSOR_POS`
A cursor on a given stream cannot be moved to a specified row without a
specified column.
<a id="ERR_INVALID_FD"></a>
+
### `ERR_INVALID_FD`
A file descriptor ('fd') was not valid (e.g. it was a negative value).
<a id="ERR_INVALID_FD_TYPE"></a>
+
### `ERR_INVALID_FD_TYPE`
A file descriptor ('fd') type was not valid.
<a id="ERR_INVALID_FILE_URL_HOST"></a>
+
### `ERR_INVALID_FILE_URL_HOST`
A Node.js API that consumes `file:` URLs (such as certain functions in the
@@ -1644,6 +1839,7 @@ situation can only occur on Unix-like systems where only `localhost` or an empty
host is supported.
<a id="ERR_INVALID_FILE_URL_PATH"></a>
+
### `ERR_INVALID_FILE_URL_PATH`
A Node.js API that consumes `file:` URLs (such as certain functions in the
@@ -1651,6 +1847,7 @@ A Node.js API that consumes `file:` URLs (such as certain functions in the
semantics for determining whether a path can be used is platform-dependent.
<a id="ERR_INVALID_HANDLE_TYPE"></a>
+
### `ERR_INVALID_HANDLE_TYPE`
An attempt was made to send an unsupported "handle" over an IPC communication
@@ -1658,17 +1855,21 @@ channel to a child process. See [`subprocess.send()`][] and [`process.send()`][]
for more information.
<a id="ERR_INVALID_HTTP_TOKEN"></a>
+
### `ERR_INVALID_HTTP_TOKEN`
An invalid HTTP token was supplied.
<a id="ERR_INVALID_IP_ADDRESS"></a>
+
### `ERR_INVALID_IP_ADDRESS`
An IP address is not valid.
<a id="ERR_INVALID_MODULE"></a>
+
### `ERR_INVALID_MODULE`
+
<!-- YAML
added:
- v15.0.0
@@ -1679,65 +1880,77 @@ An attempt was made to load a module that does not exist or was otherwise not
valid.
<a id="ERR_INVALID_MODULE_SPECIFIER"></a>
+
### `ERR_INVALID_MODULE_SPECIFIER`
The imported module string is an invalid URL, package name, or package subpath
specifier.
<a id="ERR_INVALID_PACKAGE_CONFIG"></a>
+
### `ERR_INVALID_PACKAGE_CONFIG`
An invalid [`package.json`][] file failed parsing.
<a id="ERR_INVALID_PACKAGE_TARGET"></a>
+
### `ERR_INVALID_PACKAGE_TARGET`
The `package.json` [`"exports"`][] field contains an invalid target mapping
value for the attempted module resolution.
<a id="ERR_INVALID_PERFORMANCE_MARK"></a>
+
### `ERR_INVALID_PERFORMANCE_MARK`
While using the Performance Timing API (`perf_hooks`), a performance mark is
invalid.
<a id="ERR_INVALID_PROTOCOL"></a>
+
### `ERR_INVALID_PROTOCOL`
An invalid `options.protocol` was passed to `http.request()`.
<a id="ERR_INVALID_REPL_EVAL_CONFIG"></a>
+
### `ERR_INVALID_REPL_EVAL_CONFIG`
Both `breakEvalOnSigint` and `eval` options were set in the [`REPL`][] config,
which is not supported.
<a id="ERR_INVALID_REPL_INPUT"></a>
+
### `ERR_INVALID_REPL_INPUT`
The input may not be used in the [`REPL`][]. The conditions under which this
error is used are described in the [`REPL`][] documentation.
<a id="ERR_INVALID_RETURN_PROPERTY"></a>
+
### `ERR_INVALID_RETURN_PROPERTY`
Thrown in case a function option does not provide a valid value for one of its
returned object properties on execution.
<a id="ERR_INVALID_RETURN_PROPERTY_VALUE"></a>
+
### `ERR_INVALID_RETURN_PROPERTY_VALUE`
Thrown in case a function option does not provide an expected value
type for one of its returned object properties on execution.
<a id="ERR_INVALID_RETURN_VALUE"></a>
+
### `ERR_INVALID_RETURN_VALUE`
Thrown in case a function option does not return an expected value
type on execution, such as when a function is expected to return a promise.
<a id="ERR_INVALID_STATE"></a>
+
### `ERR_INVALID_STATE`
+
<!-- YAML
added: v15.0.0
-->
@@ -1747,6 +1960,7 @@ For instance, an object may have already been destroyed, or may be
performing another operation.
<a id="ERR_INVALID_SYNC_FORK_INPUT"></a>
+
### `ERR_INVALID_SYNC_FORK_INPUT`
A `Buffer`, `TypedArray`, `DataView` or `string` was provided as stdio input to
@@ -1754,6 +1968,7 @@ an asynchronous fork. See the documentation for the [`child_process`][] module
for more information.
<a id="ERR_INVALID_THIS"></a>
+
### `ERR_INVALID_THIS`
A Node.js API function was called with an incompatible `this` value.
@@ -1767,11 +1982,13 @@ urlSearchParams.has.call(buf, 'foo');
```
<a id="ERR_INVALID_TRANSFER_OBJECT"></a>
+
### `ERR_INVALID_TRANSFER_OBJECT`
An invalid transfer object was passed to `postMessage()`.
<a id="ERR_INVALID_TUPLE"></a>
+
### `ERR_INVALID_TUPLE`
An element in the `iterable` provided to the [WHATWG][WHATWG URL API]
@@ -1780,11 +1997,13 @@ represent a `[name, value]` tuple – that is, if an element is not iterable, or
does not consist of exactly two elements.
<a id="ERR_INVALID_URI"></a>
+
### `ERR_INVALID_URI`
An invalid URI was passed.
<a id="ERR_INVALID_URL"></a>
+
### `ERR_INVALID_URL`
An invalid URL was passed to the [WHATWG][WHATWG URL API] [`URL`
@@ -1793,6 +2012,7 @@ The thrown error object typically has an additional property `'input'` that
contains the URL that failed to parse.
<a id="ERR_INVALID_URL_SCHEME"></a>
+
### `ERR_INVALID_URL_SCHEME`
An attempt was made to use a URL of an incompatible scheme (protocol) for a
@@ -1801,11 +2021,13 @@ specific purpose. It is only used in the [WHATWG URL API][] support in the
in other Node.js APIs as well in the future.
<a id="ERR_IPC_CHANNEL_CLOSED"></a>
+
### `ERR_IPC_CHANNEL_CLOSED`
An attempt was made to use an IPC communication channel that was already closed.
<a id="ERR_IPC_DISCONNECTED"></a>
+
### `ERR_IPC_DISCONNECTED`
An attempt was made to disconnect an IPC communication channel that was already
@@ -1813,6 +2035,7 @@ disconnected. See the documentation for the [`child_process`][] module
for more information.
<a id="ERR_IPC_ONE_PIPE"></a>
+
### `ERR_IPC_ONE_PIPE`
An attempt was made to create a child Node.js process using more than one IPC
@@ -1820,6 +2043,7 @@ communication channel. See the documentation for the [`child_process`][] module
for more information.
<a id="ERR_IPC_SYNC_FORK"></a>
+
### `ERR_IPC_SYNC_FORK`
An attempt was made to open an IPC communication channel with a synchronously
@@ -1827,6 +2051,7 @@ forked Node.js process. See the documentation for the [`child_process`][] module
for more information.
<a id="ERR_MANIFEST_ASSERT_INTEGRITY"></a>
+
### `ERR_MANIFEST_ASSERT_INTEGRITY`
An attempt was made to load a resource, but the resource did not match the
@@ -1834,6 +2059,7 @@ integrity defined by the policy manifest. See the documentation for [policy][]
manifests for more information.
<a id="ERR_MANIFEST_DEPENDENCY_MISSING"></a>
+
### `ERR_MANIFEST_DEPENDENCY_MISSING`
An attempt was made to load a resource, but the resource was not listed as a
@@ -1841,6 +2067,7 @@ dependency from the location that attempted to load it. See the documentation
for [policy][] manifests for more information.
<a id="ERR_MANIFEST_INTEGRITY_MISMATCH"></a>
+
### `ERR_MANIFEST_INTEGRITY_MISMATCH`
An attempt was made to load a policy manifest, but the manifest had multiple
@@ -1849,6 +2076,7 @@ entries to match in order to resolve this error. See the documentation for
[policy][] manifests for more information.
<a id="ERR_MANIFEST_INVALID_RESOURCE_FIELD"></a>
+
### `ERR_MANIFEST_INVALID_RESOURCE_FIELD`
A policy manifest resource had an invalid value for one of its fields. Update
@@ -1856,6 +2084,7 @@ the manifest entry to match in order to resolve this error. See the
documentation for [policy][] manifests for more information.
<a id="ERR_MANIFEST_INVALID_SPECIFIER"></a>
+
### `ERR_MANIFEST_INVALID_SPECIFIER`
A policy manifest resource had an invalid value for one of its dependency
@@ -1863,31 +2092,37 @@ mappings. Update the manifest entry to match to resolve this error. See the
documentation for [policy][] manifests for more information.
<a id="ERR_MANIFEST_PARSE_POLICY"></a>
+
### `ERR_MANIFEST_PARSE_POLICY`
An attempt was made to load a policy manifest, but the manifest was unable to
be parsed. See the documentation for [policy][] manifests for more information.
<a id="ERR_MANIFEST_TDZ"></a>
+
### `ERR_MANIFEST_TDZ`
An attempt was made to read from a policy manifest, but the manifest
initialization has not yet taken place. This is likely a bug in Node.js.
<a id="ERR_MANIFEST_UNKNOWN_ONERROR"></a>
+
### `ERR_MANIFEST_UNKNOWN_ONERROR`
A policy manifest was loaded, but had an unknown value for its "onerror"
behavior. See the documentation for [policy][] manifests for more information.
<a id="ERR_MEMORY_ALLOCATION_FAILED"></a>
+
### `ERR_MEMORY_ALLOCATION_FAILED`
An attempt was made to allocate memory (usually in the C++ layer) but it
failed.
<a id="ERR_MESSAGE_TARGET_CONTEXT_UNAVAILABLE"></a>
+
### `ERR_MESSAGE_TARGET_CONTEXT_UNAVAILABLE`
+
<!-- YAML
added:
- v14.5.0
@@ -1900,11 +2135,13 @@ any context at this time, and attempting to transfer them using `postMessage()`
can fail on the receiving side in that case.
<a id="ERR_METHOD_NOT_IMPLEMENTED"></a>
+
### `ERR_METHOD_NOT_IMPLEMENTED`
A method is required but not implemented.
<a id="ERR_MISSING_ARGS"></a>
+
### `ERR_MISSING_ARGS`
A required argument of a Node.js API was not passed. This is only used for
@@ -1914,17 +2151,20 @@ strict compliance with the API specification (which in some cases may accept
[`ERR_INVALID_ARG_TYPE`][] error code may be used instead.
<a id="ERR_MISSING_OPTION"></a>
+
### `ERR_MISSING_OPTION`
For APIs that accept options objects, some options might be mandatory. This code
is thrown if a required option is missing.
<a id="ERR_MISSING_PASSPHRASE"></a>
+
### `ERR_MISSING_PASSPHRASE`
An attempt was made to read an encrypted key without specifying a passphrase.
<a id="ERR_MISSING_PLATFORM_FOR_WORKER"></a>
+
### `ERR_MISSING_PLATFORM_FOR_WORKER`
The V8 platform used by this instance of Node.js does not support creating
@@ -1932,7 +2172,9 @@ Workers. This is caused by lack of embedder support for Workers. In particular,
this error will not occur with standard builds of Node.js.
<a id="ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST"></a>
+
### `ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST`
+
<!-- YAML
added: v15.0.0
-->
@@ -1947,6 +2189,7 @@ transferable object types has been expanded to cover more types than
`MessagePort`.
<a id="ERR_MODULE_NOT_FOUND"></a>
+
### `ERR_MODULE_NOT_FOUND`
> Stability: 1 - Experimental
@@ -1954,6 +2197,7 @@ transferable object types has been expanded to cover more types than
An [ES Module][] could not be resolved.
<a id="ERR_MULTIPLE_CALLBACK"></a>
+
### `ERR_MULTIPLE_CALLBACK`
A callback was called more than once.
@@ -1963,41 +2207,48 @@ can either be fulfilled or rejected but not both at the same time. The latter
would be possible by calling a callback more than once.
<a id="ERR_NAPI_CONS_FUNCTION"></a>
+
### `ERR_NAPI_CONS_FUNCTION`
While using `Node-API`, a constructor passed was not a function.
<a id="ERR_NAPI_INVALID_DATAVIEW_ARGS"></a>
+
### `ERR_NAPI_INVALID_DATAVIEW_ARGS`
While calling `napi_create_dataview()`, a given `offset` was outside the bounds
of the dataview or `offset + length` was larger than a length of given `buffer`.
<a id="ERR_NAPI_INVALID_TYPEDARRAY_ALIGNMENT"></a>
+
### `ERR_NAPI_INVALID_TYPEDARRAY_ALIGNMENT`
While calling `napi_create_typedarray()`, the provided `offset` was not a
multiple of the element size.
<a id="ERR_NAPI_INVALID_TYPEDARRAY_LENGTH"></a>
+
### `ERR_NAPI_INVALID_TYPEDARRAY_LENGTH`
While calling `napi_create_typedarray()`, `(length * size_of_element) +
byte_offset` was larger than the length of given `buffer`.
<a id="ERR_NAPI_TSFN_CALL_JS"></a>
+
### `ERR_NAPI_TSFN_CALL_JS`
An error occurred while invoking the JavaScript portion of the thread-safe
function.
<a id="ERR_NAPI_TSFN_GET_UNDEFINED"></a>
+
### `ERR_NAPI_TSFN_GET_UNDEFINED`
An error occurred while attempting to retrieve the JavaScript `undefined`
value.
<a id="ERR_NAPI_TSFN_START_IDLE_LOOP"></a>
+
### `ERR_NAPI_TSFN_START_IDLE_LOOP`
On the main thread, values are removed from the queue associated with the
@@ -2005,40 +2256,47 @@ thread-safe function in an idle loop. This error indicates that an error
has occurred when attempting to start the loop.
<a id="ERR_NAPI_TSFN_STOP_IDLE_LOOP"></a>
+
### `ERR_NAPI_TSFN_STOP_IDLE_LOOP`
Once no more items are left in the queue, the idle loop must be suspended. This
error indicates that the idle loop has failed to stop.
<a id="ERR_NO_CRYPTO"></a>
+
### `ERR_NO_CRYPTO`
An attempt was made to use crypto features while Node.js was not compiled with
OpenSSL crypto support.
<a id="ERR_NO_ICU"></a>
+
### `ERR_NO_ICU`
An attempt was made to use features that require [ICU][], but Node.js was not
compiled with ICU support.
<a id="ERR_NON_CONTEXT_AWARE_DISABLED"></a>
+
### `ERR_NON_CONTEXT_AWARE_DISABLED`
A non-context-aware native addon was loaded in a process that disallows them.
<a id="ERR_OUT_OF_RANGE"></a>
+
### `ERR_OUT_OF_RANGE`
A given value is out of the accepted range.
<a id="ERR_PACKAGE_IMPORT_NOT_DEFINED"></a>
+
### `ERR_PACKAGE_IMPORT_NOT_DEFINED`
The `package.json` [`"imports"`][] field does not define the given internal
package specifier mapping.
<a id="ERR_PACKAGE_PATH_NOT_EXPORTED"></a>
+
### `ERR_PACKAGE_PATH_NOT_EXPORTED`
The `package.json` [`"exports"`][] field does not export the requested subpath.
@@ -2046,16 +2304,19 @@ Because exports are encapsulated, private internal modules that are not exported
cannot be imported through the package resolution, unless using an absolute URL.
<a id="ERR_PERFORMANCE_INVALID_TIMESTAMP"></a>
+
### `ERR_PERFORMANCE_INVALID_TIMESTAMP`
An invalid timestamp value was provided for a performance mark or measure.
<a id="ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS"></a>
+
### `ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS`
Invalid options were provided for a performance measure.
<a id="ERR_PROTO_ACCESS"></a>
+
### `ERR_PROTO_ACCESS`
Accessing `Object.prototype.__proto__` has been forbidden using
@@ -2064,6 +2325,7 @@ Accessing `Object.prototype.__proto__` has been forbidden using
object.
<a id="ERR_REQUIRE_ESM"></a>
+
### `ERR_REQUIRE_ESM`
> Stability: 1 - Experimental
@@ -2071,17 +2333,20 @@ object.
An attempt was made to `require()` an [ES Module][].
<a id="ERR_SCRIPT_EXECUTION_INTERRUPTED"></a>
+
### `ERR_SCRIPT_EXECUTION_INTERRUPTED`
-Script execution was interrupted by `SIGINT` (For example,
-<kbd>Ctrl</kbd>+<kbd>C</kbd> was pressed.)
+Script execution was interrupted by `SIGINT` (For
+example, <kbd>Ctrl</kbd>+<kbd>C</kbd> was pressed.)
<a id="ERR_SCRIPT_EXECUTION_TIMEOUT"></a>
+
### `ERR_SCRIPT_EXECUTION_TIMEOUT`
Script execution timed out, possibly due to bugs in the script being executed.
<a id="ERR_SERVER_ALREADY_LISTEN"></a>
+
### `ERR_SERVER_ALREADY_LISTEN`
The [`server.listen()`][] method was called while a `net.Server` was already
@@ -2089,6 +2354,7 @@ listening. This applies to all instances of `net.Server`, including HTTP, HTTPS,
and HTTP/2 `Server` instances.
<a id="ERR_SERVER_NOT_RUNNING"></a>
+
### `ERR_SERVER_NOT_RUNNING`
The [`server.close()`][] method was called when a `net.Server` was not
@@ -2096,55 +2362,65 @@ running. This applies to all instances of `net.Server`, including HTTP, HTTPS,
and HTTP/2 `Server` instances.
<a id="ERR_SOCKET_ALREADY_BOUND"></a>
+
### `ERR_SOCKET_ALREADY_BOUND`
An attempt was made to bind a socket that has already been bound.
<a id="ERR_SOCKET_BAD_BUFFER_SIZE"></a>
+
### `ERR_SOCKET_BAD_BUFFER_SIZE`
An invalid (negative) size was passed for either the `recvBufferSize` or
`sendBufferSize` options in [`dgram.createSocket()`][].
<a id="ERR_SOCKET_BAD_PORT"></a>
+
### `ERR_SOCKET_BAD_PORT`
An API function expecting a port >= 0 and < 65536 received an invalid value.
<a id="ERR_SOCKET_BAD_TYPE"></a>
+
### `ERR_SOCKET_BAD_TYPE`
An API function expecting a socket type (`udp4` or `udp6`) received an invalid
value.
<a id="ERR_SOCKET_BUFFER_SIZE"></a>
+
### `ERR_SOCKET_BUFFER_SIZE`
While using [`dgram.createSocket()`][], the size of the receive or send `Buffer`
could not be determined.
<a id="ERR_SOCKET_CLOSED"></a>
+
### `ERR_SOCKET_CLOSED`
An attempt was made to operate on an already closed socket.
<a id="ERR_SOCKET_DGRAM_IS_CONNECTED"></a>
+
### `ERR_SOCKET_DGRAM_IS_CONNECTED`
A [`dgram.connect()`][] call was made on an already connected socket.
<a id="ERR_SOCKET_DGRAM_NOT_CONNECTED"></a>
+
### `ERR_SOCKET_DGRAM_NOT_CONNECTED`
A [`dgram.disconnect()`][] or [`dgram.remoteAddress()`][] call was made on a
disconnected socket.
<a id="ERR_SOCKET_DGRAM_NOT_RUNNING"></a>
+
### `ERR_SOCKET_DGRAM_NOT_RUNNING`
A call was made and the UDP subsystem was not running.
<a id="ERR_SRI_PARSE"></a>
+
### `ERR_SRI_PARSE`
A string was provided for a Subresource Integrity check, but was unable to be
@@ -2152,46 +2428,54 @@ parsed. Check the format of integrity attributes by looking at the
[Subresource Integrity specification][].
<a id="ERR_STREAM_ALREADY_FINISHED"></a>
+
### `ERR_STREAM_ALREADY_FINISHED`
A stream method was called that cannot complete because the stream was
finished.
<a id="ERR_STREAM_CANNOT_PIPE"></a>
+
### `ERR_STREAM_CANNOT_PIPE`
An attempt was made to call [`stream.pipe()`][] on a [`Writable`][] stream.
<a id="ERR_STREAM_DESTROYED"></a>
+
### `ERR_STREAM_DESTROYED`
A stream method was called that cannot complete because the stream was
destroyed using `stream.destroy()`.
<a id="ERR_STREAM_NULL_VALUES"></a>
+
### `ERR_STREAM_NULL_VALUES`
An attempt was made to call [`stream.write()`][] with a `null` chunk.
<a id="ERR_STREAM_PREMATURE_CLOSE"></a>
+
### `ERR_STREAM_PREMATURE_CLOSE`
An error returned by `stream.finished()` and `stream.pipeline()`, when a stream
or a pipeline ends non gracefully with no explicit error.
<a id="ERR_STREAM_PUSH_AFTER_EOF"></a>
+
### `ERR_STREAM_PUSH_AFTER_EOF`
An attempt was made to call [`stream.push()`][] after a `null`(EOF) had been
pushed to the stream.
<a id="ERR_STREAM_UNSHIFT_AFTER_END_EVENT"></a>
+
### `ERR_STREAM_UNSHIFT_AFTER_END_EVENT`
An attempt was made to call [`stream.unshift()`][] after the `'end'` event was
emitted.
<a id="ERR_STREAM_WRAP"></a>
+
### `ERR_STREAM_WRAP`
Prevents an abort if a string decoder was set on the Socket or if the decoder
@@ -2205,24 +2489,28 @@ instance.setEncoding('utf8');
```
<a id="ERR_STREAM_WRITE_AFTER_END"></a>
+
### `ERR_STREAM_WRITE_AFTER_END`
An attempt was made to call [`stream.write()`][] after `stream.end()` has been
called.
<a id="ERR_STRING_TOO_LONG"></a>
+
### `ERR_STRING_TOO_LONG`
An attempt has been made to create a string longer than the maximum allowed
length.
<a id="ERR_SYNTHETIC"></a>
+
### `ERR_SYNTHETIC`
An artificial error object used to capture the call stack for diagnostic
reports.
<a id="ERR_SYSTEM_ERROR"></a>
+
### `ERR_SYSTEM_ERROR`
An unspecified or non-specific system error has occurred within the Node.js
@@ -2230,12 +2518,14 @@ process. The error object will have an `err.info` object property with
additional details.
<a id="ERR_TLS_CERT_ALTNAME_INVALID"></a>
+
### `ERR_TLS_CERT_ALTNAME_INVALID`
While using TLS, the host name/IP of the peer did not match any of the
`subjectAltNames` in its certificate.
<a id="ERR_TLS_DH_PARAM_SIZE"></a>
+
### `ERR_TLS_DH_PARAM_SIZE`
While using TLS, the parameter offered for the Diffie-Hellman (`DH`)
@@ -2244,13 +2534,16 @@ than or equal to 1024 bits to avoid vulnerabilities, even though it is strongly
recommended to use 2048 bits or larger for stronger security.
<a id="ERR_TLS_HANDSHAKE_TIMEOUT"></a>
+
### `ERR_TLS_HANDSHAKE_TIMEOUT`
A TLS/SSL handshake timed out. In this case, the server must also abort the
connection.
<a id="ERR_TLS_INVALID_CONTEXT"></a>
+
### `ERR_TLS_INVALID_CONTEXT`
+
<!-- YAML
added: v13.3.0
-->
@@ -2258,18 +2551,22 @@ added: v13.3.0
The context must be a `SecureContext`.
<a id="ERR_TLS_INVALID_PROTOCOL_METHOD"></a>
+
### `ERR_TLS_INVALID_PROTOCOL_METHOD`
The specified `secureProtocol` method is invalid. It is either unknown, or
disabled because it is insecure.
<a id="ERR_TLS_INVALID_PROTOCOL_VERSION"></a>
+
### `ERR_TLS_INVALID_PROTOCOL_VERSION`
Valid TLS protocol versions are `'TLSv1'`, `'TLSv1.1'`, or `'TLSv1.2'`.
<a id="ERR_TLS_INVALID_STATE"></a>
+
### `ERR_TLS_INVALID_STATE`
+
<!-- YAML
added:
- v13.10.0
@@ -2280,73 +2577,86 @@ The TLS socket must be connected and securily established. Ensure the 'secure'
event is emitted before continuing.
<a id="ERR_TLS_PROTOCOL_VERSION_CONFLICT"></a>
+
### `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.
<a id="ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED"></a>
+
### `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED`
Failed to set PSK identity hint. Hint may be too long.
<a id="ERR_TLS_RENEGOTIATION_DISABLED"></a>
+
### `ERR_TLS_RENEGOTIATION_DISABLED`
An attempt was made to renegotiate TLS on a socket instance with TLS disabled.
<a id="ERR_TLS_REQUIRED_SERVER_NAME"></a>
+
### `ERR_TLS_REQUIRED_SERVER_NAME`
While using TLS, the `server.addContext()` method was called without providing
a host name in the first parameter.
<a id="ERR_TLS_SESSION_ATTACK"></a>
+
### `ERR_TLS_SESSION_ATTACK`
An excessive amount of TLS renegotiations is detected, which is a potential
vector for denial-of-service attacks.
<a id="ERR_TLS_SNI_FROM_SERVER"></a>
+
### `ERR_TLS_SNI_FROM_SERVER`
An attempt was made to issue Server Name Indication from a TLS server-side
socket, which is only valid from a client.
<a id="ERR_TRACE_EVENTS_CATEGORY_REQUIRED"></a>
+
### `ERR_TRACE_EVENTS_CATEGORY_REQUIRED`
The `trace_events.createTracing()` method requires at least one trace event
category.
<a id="ERR_TRACE_EVENTS_UNAVAILABLE"></a>
+
### `ERR_TRACE_EVENTS_UNAVAILABLE`
The `trace_events` module could not be loaded because Node.js was compiled with
the `--without-v8-platform` flag.
<a id="ERR_TRANSFORM_ALREADY_TRANSFORMING"></a>
+
### `ERR_TRANSFORM_ALREADY_TRANSFORMING`
A `Transform` stream finished while it was still transforming.
<a id="ERR_TRANSFORM_WITH_LENGTH_0"></a>
+
### `ERR_TRANSFORM_WITH_LENGTH_0`
A `Transform` stream finished with data still in the write buffer.
<a id="ERR_TTY_INIT_FAILED"></a>
+
### `ERR_TTY_INIT_FAILED`
The initialization of a TTY failed due to a system error.
<a id="ERR_UNAVAILABLE_DURING_EXIT"></a>
+
### `ERR_UNAVAILABLE_DURING_EXIT`
Function was called within a [`process.on('exit')`][] handler that shouldn't be
called within [`process.on('exit')`][] handler.
<a id="ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET"></a>
+
### `ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET`
[`process.setUncaughtExceptionCaptureCallback()`][] was called twice,
@@ -2356,17 +2666,20 @@ This error is designed to prevent accidentally overwriting a callback registered
from another module.
<a id="ERR_UNESCAPED_CHARACTERS"></a>
+
### `ERR_UNESCAPED_CHARACTERS`
A string that contained unescaped characters was received.
<a id="ERR_UNHANDLED_ERROR"></a>
+
### `ERR_UNHANDLED_ERROR`
An unhandled error occurred (for instance, when an `'error'` event is emitted
by an [`EventEmitter`][] but an `'error'` handler is not registered).
<a id="ERR_UNKNOWN_BUILTIN_MODULE"></a>
+
### `ERR_UNKNOWN_BUILTIN_MODULE`
Used to identify a specific kind of internal Node.js error that should not
@@ -2374,16 +2687,19 @@ typically be triggered by user code. Instances of this error point to an
internal bug within the Node.js binary itself.
<a id="ERR_UNKNOWN_CREDENTIAL"></a>
+
### `ERR_UNKNOWN_CREDENTIAL`
A Unix group or user identifier that does not exist was passed.
<a id="ERR_UNKNOWN_ENCODING"></a>
+
### `ERR_UNKNOWN_ENCODING`
An invalid or unknown encoding option was passed to an API.
<a id="ERR_UNKNOWN_FILE_EXTENSION"></a>
+
### `ERR_UNKNOWN_FILE_EXTENSION`
> Stability: 1 - Experimental
@@ -2392,6 +2708,7 @@ An attempt was made to load a module with an unknown or unsupported file
extension.
<a id="ERR_UNKNOWN_MODULE_FORMAT"></a>
+
### `ERR_UNKNOWN_MODULE_FORMAT`
> Stability: 1 - Experimental
@@ -2399,12 +2716,14 @@ extension.
An attempt was made to load a module with an unknown or unsupported format.
<a id="ERR_UNKNOWN_SIGNAL"></a>
+
### `ERR_UNKNOWN_SIGNAL`
An invalid or unknown process signal was passed to an API expecting a valid
signal (such as [`subprocess.kill()`][]).
<a id="ERR_UNSUPPORTED_DIR_IMPORT"></a>
+
### `ERR_UNSUPPORTED_DIR_IMPORT`
`import` a directory URL is unsupported. Instead,
@@ -2412,6 +2731,7 @@ signal (such as [`subprocess.kill()`][]).
the [`"exports"`][] field of the [`package.json`][] file.
<!-- eslint-skip -->
+
```js
import './'; // unsupported
import './index.js'; // supported
@@ -2419,22 +2739,26 @@ import 'package-name'; // supported
```
<a id="ERR_UNSUPPORTED_ESM_URL_SCHEME"></a>
+
### `ERR_UNSUPPORTED_ESM_URL_SCHEME`
`import` with URL schemes other than `file` and `data` is unsupported.
<a id="ERR_VALID_PERFORMANCE_ENTRY_TYPE"></a>
+
### `ERR_VALID_PERFORMANCE_ENTRY_TYPE`
While using the Performance Timing API (`perf_hooks`), no valid performance
entry types are found.
<a id="ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING"></a>
+
### `ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`
A dynamic import callback was not specified.
<a id="ERR_VM_MODULE_ALREADY_LINKED"></a>
+
### `ERR_VM_MODULE_ALREADY_LINKED`
The module attempted to be linked is not eligible for linking, because of one of
@@ -2445,96 +2769,115 @@ the following reasons:
* Linking has failed for this module (`linkingStatus` is `'errored'`)
<a id="ERR_VM_MODULE_CACHED_DATA_REJECTED"></a>
+
### `ERR_VM_MODULE_CACHED_DATA_REJECTED`
The `cachedData` option passed to a module constructor is invalid.
<a id="ERR_VM_MODULE_CANNOT_CREATE_CACHED_DATA"></a>
+
### `ERR_VM_MODULE_CANNOT_CREATE_CACHED_DATA`
Cached data cannot be created for modules which have already been evaluated.
<a id="ERR_VM_MODULE_DIFFERENT_CONTEXT"></a>
+
### `ERR_VM_MODULE_DIFFERENT_CONTEXT`
The module being returned from the linker function is from a different context
than the parent module. Linked modules must share the same context.
<a id="ERR_VM_MODULE_LINKING_ERRORED"></a>
+
### `ERR_VM_MODULE_LINKING_ERRORED`
The linker function returned a module for which linking has failed.
<a id="ERR_VM_MODULE_LINK_FAILURE"></a>
+
### `ERR_VM_MODULE_LINK_FAILURE`
The module was unable to be linked due to a failure.
<a id="ERR_VM_MODULE_NOT_MODULE"></a>
+
### `ERR_VM_MODULE_NOT_MODULE`
The fulfilled value of a linking promise is not a `vm.Module` object.
<a id="ERR_VM_MODULE_STATUS"></a>
+
### `ERR_VM_MODULE_STATUS`
The current module's status does not allow for this operation. The specific
meaning of the error depends on the specific function.
<a id="ERR_WASI_ALREADY_STARTED"></a>
+
### `ERR_WASI_ALREADY_STARTED`
The WASI instance has already started.
<a id="ERR_WASI_NOT_STARTED"></a>
+
### `ERR_WASI_NOT_STARTED`
The WASI instance has not been started.
<a id="ERR_WORKER_INIT_FAILED"></a>
+
### `ERR_WORKER_INIT_FAILED`
The `Worker` initialization failed.
<a id="ERR_WORKER_INVALID_EXEC_ARGV"></a>
+
### `ERR_WORKER_INVALID_EXEC_ARGV`
The `execArgv` option passed to the `Worker` constructor contains
invalid flags.
<a id="ERR_WORKER_NOT_RUNNING"></a>
+
### `ERR_WORKER_NOT_RUNNING`
An operation failed because the `Worker` instance is not currently running.
<a id="ERR_WORKER_OUT_OF_MEMORY"></a>
+
### `ERR_WORKER_OUT_OF_MEMORY`
The `Worker` instance terminated because it reached its memory limit.
<a id="ERR_WORKER_PATH"></a>
+
### `ERR_WORKER_PATH`
The path for the main script of a worker is neither an absolute path
nor a relative path starting with `./` or `../`.
<a id="ERR_WORKER_UNSERIALIZABLE_ERROR"></a>
+
### `ERR_WORKER_UNSERIALIZABLE_ERROR`
All attempts at serializing an uncaught exception from a worker thread failed.
<a id="ERR_WORKER_UNSUPPORTED_OPERATION"></a>
+
### `ERR_WORKER_UNSUPPORTED_OPERATION`
The requested functionality is not supported in worker threads.
<a id="ERR_ZLIB_INITIALIZATION_FAILED"></a>
+
### `ERR_ZLIB_INITIALIZATION_FAILED`
Creation of a [`zlib`][] object failed due to incorrect configuration.
<a id="HPE_HEADER_OVERFLOW"></a>
+
### `HPE_HEADER_OVERFLOW`
+
<!-- YAML
changes:
- version:
@@ -2551,6 +2894,7 @@ HTTP parsing will abort without a request or response object being created, and
an `Error` with this code will be emitted.
<a id="HPE_UNEXPECTED_CONTENT_LENGTH"></a>
+
### `HPE_UNEXPECTED_CONTENT_LENGTH`
Server is sending both a `Content-Length` header and `Transfer-Encoding: chunked`.
@@ -2562,13 +2906,16 @@ In this case, the `Content-Length` HTTP header cannot be used.
Use `Content-Length` or `Transfer-Encoding: chunked`.
<a id="MODULE_NOT_FOUND"></a>
+
### `MODULE_NOT_FOUND`
+
<!-- YAML
changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/25690
description: Added `requireStack` property.
-->
+
A module file could not be resolved while attempting a [`require()`][] or
`import` operation.
@@ -2578,7 +2925,9 @@ A module file could not be resolved while attempting a [`require()`][] or
> been removed.
<a id="ERR_CANNOT_TRANSFER_OBJECT"></a>
+
### `ERR_CANNOT_TRANSFER_OBJECT`
+
<!--
added: v10.5.0
removed: v12.5.0
@@ -2588,7 +2937,9 @@ The value passed to `postMessage()` contained an object that is not supported
for transferring.
<a id="ERR_CRYPTO_HASH_DIGEST_NO_UTF16"></a>
+
### `ERR_CRYPTO_HASH_DIGEST_NO_UTF16`
+
<!-- YAML
added: v9.0.0
removed: v12.12.0
@@ -2600,7 +2951,9 @@ causing the method to return a string rather than a `Buffer`, the UTF-16
encoding (e.g. `ucs` or `utf16le`) is not supported.
<a id="ERR_HTTP2_FRAME_ERROR"></a>
+
### `ERR_HTTP2_FRAME_ERROR`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2610,7 +2963,9 @@ Used when a failure occurs sending an individual frame on the HTTP/2
session.
<a id="ERR_HTTP2_HEADERS_OBJECT"></a>
+
### `ERR_HTTP2_HEADERS_OBJECT`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2619,7 +2974,9 @@ removed: v10.0.0
Used when an HTTP/2 Headers Object is expected.
<a id="ERR_HTTP2_HEADER_REQUIRED"></a>
+
### `ERR_HTTP2_HEADER_REQUIRED`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2628,17 +2985,21 @@ removed: v10.0.0
Used when a required header is missing in an HTTP/2 message.
<a id="ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND"></a>
+
### `ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
-HTTP/2 informational headers must only be sent *prior* to calling the
+HTTP/2 informational headers must only be sent _prior_ to calling the
`Http2Stream.prototype.respond()` method.
<a id="ERR_HTTP2_STREAM_CLOSED"></a>
+
### `ERR_HTTP2_STREAM_CLOSED`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2648,7 +3009,9 @@ Used when an action has been performed on an HTTP/2 Stream that has already
been closed.
<a id="ERR_HTTP_INVALID_CHAR"></a>
+
### `ERR_HTTP_INVALID_CHAR`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2658,15 +3021,20 @@ Used when an invalid character is found in an HTTP response status message
(reason phrase).
<a id="ERR_INDEX_OUT_OF_RANGE"></a>
+
### `ERR_INDEX_OUT_OF_RANGE`
+
<!-- YAML
added: v10.0.0
removed: v11.0.0
-->
+
A given index was out of the accepted range (e.g. negative offsets).
<a id="ERR_INVALID_OPT_VALUE"></a>
+
### `ERR_INVALID_OPT_VALUE`
+
<!-- YAML
added: v8.0.0
removed: v15.0.0
@@ -2675,7 +3043,9 @@ removed: v15.0.0
An invalid or unexpected value was passed in an options object.
<a id="ERR_INVALID_OPT_VALUE_ENCODING"></a>
+
### `ERR_INVALID_OPT_VALUE_ENCODING`
+
<!-- YAML
added: v9.0.0
removed: v15.0.0
@@ -2684,7 +3054,9 @@ removed: v15.0.0
An invalid or unknown file encoding was passed.
<a id="ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST"></a>
+
### `ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`
+
<!-- YAML
removed: v15.0.0
-->
@@ -2694,7 +3066,9 @@ in Node.js v15.0.0, because it is no longer accurate as other types of
transferable objects also exist now.
<a id="ERR_NAPI_CONS_PROTOTYPE_OBJECT"></a>
+
### `ERR_NAPI_CONS_PROTOTYPE_OBJECT`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2703,13 +3077,16 @@ removed: v10.0.0
Used by the `Node-API` when `Constructor.prototype` is not an object.
<a id="ERR_NO_LONGER_SUPPORTED"></a>
+
### `ERR_NO_LONGER_SUPPORTED`
A Node.js API was called in an unsupported manner, such as
`Buffer.write(string, encoding, offset[, length])`.
<a id="ERR_OPERATION_FAILED"></a>
+
### `ERR_OPERATION_FAILED`
+
<!-- YAML
added: v15.0.0
-->
@@ -2718,7 +3095,9 @@ An operation failed. This is typically used to signal the general failure
of an asynchronous operation.
<a id="ERR_OUTOFMEMORY"></a>
+
### `ERR_OUTOFMEMORY`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2728,7 +3107,9 @@ Used generically to identify that an operation caused an out of memory
condition.
<a id="ERR_PARSE_HISTORY_DATA"></a>
+
### `ERR_PARSE_HISTORY_DATA`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2737,7 +3118,9 @@ removed: v10.0.0
The `repl` module was unable to parse data from the REPL history file.
<a id="ERR_SOCKET_CANNOT_SEND"></a>
+
### `ERR_SOCKET_CANNOT_SEND`
+
<!-- YAML
added: v9.0.0
removed: v14.0.0
@@ -2746,7 +3129,9 @@ removed: v14.0.0
Data could not be sent on a socket.
<a id="ERR_STDERR_CLOSE"></a>
+
### `ERR_STDERR_CLOSE`
+
<!-- YAML
removed: v10.12.0
changes:
@@ -2761,7 +3146,9 @@ An attempt was made to close the `process.stderr` stream. By design, Node.js
does not allow `stdout` or `stderr` streams to be closed by user code.
<a id="ERR_STDOUT_CLOSE"></a>
+
### `ERR_STDOUT_CLOSE`
+
<!-- YAML
removed: v10.12.0
changes:
@@ -2776,7 +3163,9 @@ An attempt was made to close the `process.stdout` stream. By design, Node.js
does not allow `stdout` or `stderr` streams to be closed by user code.
<a id="ERR_STREAM_READ_NOT_IMPLEMENTED"></a>
+
### `ERR_STREAM_READ_NOT_IMPLEMENTED`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2786,7 +3175,9 @@ Used when an attempt is made to use a readable stream that has not implemented
[`readable._read()`][].
<a id="ERR_TLS_RENEGOTIATION_FAILED"></a>
+
### `ERR_TLS_RENEGOTIATION_FAILED`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2795,7 +3186,9 @@ removed: v10.0.0
Used when a TLS renegotiation request has failed in a non-specific way.
<a id="ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER"></a>
+
### `ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER`
+
<!-- YAML
added: v10.5.0
removed: v14.0.0
@@ -2809,7 +3202,9 @@ This can only happen when native addons create `SharedArrayBuffer`s in
"externalized" mode, or put existing `SharedArrayBuffer` into externalized mode.
<a id="ERR_UNKNOWN_STDIN_TYPE"></a>
+
### `ERR_UNKNOWN_STDIN_TYPE`
+
<!-- YAML
added: v8.0.0
removed: v11.7.0
@@ -2820,7 +3215,9 @@ type. This error is usually an indication of a bug within Node.js itself,
although it is possible for user code to trigger it.
<a id="ERR_UNKNOWN_STREAM_TYPE"></a>
+
### `ERR_UNKNOWN_STREAM_TYPE`
+
<!-- YAML
added: v8.0.0
removed: v11.7.0
@@ -2831,12 +3228,15 @@ An attempt was made to launch a Node.js process with an unknown `stdout` or
itself, although it is possible for user code to trigger it.
<a id="ERR_V8BREAKITERATOR"></a>
+
### `ERR_V8BREAKITERATOR`
The V8 `BreakIterator` API was used but the full ICU data set is not installed.
<a id="ERR_VALUE_OUT_OF_RANGE"></a>
+
### `ERR_VALUE_OUT_OF_RANGE`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2845,12 +3245,15 @@ removed: v10.0.0
Used when a given value is out of the accepted range.
<a id="ERR_VM_MODULE_NOT_LINKED"></a>
+
### `ERR_VM_MODULE_NOT_LINKED`
The module must be successfully linked before instantiation.
<a id="ERR_WORKER_UNSUPPORTED_EXTENSION"></a>
+
### `ERR_WORKER_UNSUPPORTED_EXTENSION`
+
<!-- YAML
added: v11.0.0
removed: v16.9.0
@@ -2860,7 +3263,9 @@ The pathname used for the main script of a worker has an
unknown file extension.
<a id="ERR_ZLIB_BINDING_CLOSED"></a>
+
### `ERR_ZLIB_BINDING_CLOSED`
+
<!-- YAML
added: v9.0.0
removed: v10.0.0
@@ -2870,7 +3275,9 @@ Used when an attempt is made to use a `zlib` object after it has already been
closed.
<a id="ERR_CPU_USAGE"></a>
+
### `ERR_CPU_USAGE`
+
<!-- YAML
removed: v15.0.0
-->