A generic JavaScript Error object that does not denote any specific\ncircumstance of why the error occurred. Error objects capture a \"stack trace\"\ndetailing the point in the code at which the Error was instantiated, and may\nprovide a text description of the error.
For crypto only, Error objects will include the OpenSSL error stack in a\nseparate property called opensslErrorStack if it is available when the error\nis thrown.
All errors generated by Node.js, including all System and JavaScript errors,\nwill either be instances of, or inherit from, the Error class.
Creates a .stack property on targetObject, which when accessed returns\na string representing the location in the code at which\nError.captureStackTrace() was called.
const myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack; // similar to `new Error().stack`\nThe first line of the trace will be prefixed with\n${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames\nabove constructorOpt, including constructorOpt, will be omitted from the\ngenerated stack trace.
The constructorOpt argument is useful for hiding implementation\ndetails of error generation from an end user. For instance:
function MyError() {\n Error.captureStackTrace(this, MyError);\n}\n\n// Without passing MyError to captureStackTrace, the MyError\n// frame would show up in the .stack property. By passing\n// the constructor, we omit that frame, and retain all frames below it.\nnew MyError().stack;\nThe Error.stackTraceLimit property specifies the number of stack frames\ncollected by a stack trace (whether generated by new Error().stack or\nError.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes\nwill 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\nnot capture any frames.
" }, { "textRaw": "`code` {string}", "type": "string", "name": "code", "desc": "The error.code property is a string label that identifies the kind of error.\nerror.code is the most stable way to identify an error. It will only change\nbetween major versions of Node.js. In contrast, error.message strings may\nchange between any versions of Node.js. See Node.js Error Codes for details\nabout specific codes.
The error.message property is the string description of the error as set by\ncalling new Error(message). The message passed to the constructor will also\nappear in the first line of the stack trace of the Error, however changing\nthis property after the Error object is created may not change the first\nline of the stack trace (for example, when error.stack is read before this\nproperty is changed).
const err = new Error('The message');\nconsole.error(err.message);\n// Prints: The message\nThe error.stack property is a string describing the point in the code at which\nthe Error was instantiated.
Error: Things keep happening!\n at /home/gbusey/file.js:525:2\n at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)\n at Actor.<anonymous> (/home/gbusey/actors.js:400:8)\n at increaseSynergy (/home/gbusey/actors.js:701:6)\nThe first line is formatted as <error class name>: <error message>, and\nis followed by a series of stack frames (each line beginning with \"at \").\nEach frame describes a call site within the code that lead to the error being\ngenerated. V8 attempts to display a name for each function (by variable name,\nfunction name, or object method name), but occasionally it will not be able to\nfind a suitable name. If V8 cannot determine a name for the function, only\nlocation information will be displayed for that frame. Otherwise, the\ndetermined function name will be displayed with location information appended\nin parentheses.
Frames are only generated for JavaScript functions. If, for example, execution\nsynchronously passes through a C++ addon function called cheetahify which\nitself calls a JavaScript function, the frame representing the cheetahify call\nwill not be present in the stack traces:
const cheetahify = require('./native-binding.node');\n\nfunction makeFaster() {\n // cheetahify *synchronously* calls speedy.\n cheetahify(function speedy() {\n throw new Error('oh no!');\n });\n}\n\nmakeFaster();\n// will throw:\n// /home/gbusey/file.js:6\n// throw new Error('oh no!');\n// ^\n// Error: oh no!\n// at speedy (/home/gbusey/file.js:6:11)\n// at makeFaster (/home/gbusey/file.js:5:3)\n// at Object.<anonymous> (/home/gbusey/file.js:10:1)\n// at Module._compile (module.js:456:26)\n// at Object.Module._extensions..js (module.js:474:10)\n// at Module.load (module.js:356:32)\n// at Function.Module._load (module.js:312:12)\n// at Function.Module.runMain (module.js:497:10)\n// at startup (node.js:119:16)\n// at node.js:906:3\nThe location information will be one of:
\nnative, if the frame represents a call internal to V8 (as in [].forEach).plain-filename.js:line:column, if the frame represents a call internal\nto Node.js./absolute/path/to/file.js:line:column, if the frame represents a call in\na user program, or its dependencies.The string representing the stack trace is lazily generated when the\nerror.stack property is accessed.
The number of frames captured by the stack trace is bounded by the smaller of\nError.stackTraceLimit or the number of available frames on the current event\nloop tick.
System-level errors are generated as augmented Error instances, which are\ndetailed here.
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
A subclass of Error that indicates the failure of an assertion. For details,\nsee Class: assert.AssertionError.
A subclass of Error that indicates that a provided argument was not within the\nset or range of acceptable values for a function; whether that is a numeric\nrange, or outside the set of options for a given function parameter.
require('net').connect(-1);\n// throws \"RangeError: \"port\" option should be >= 0 and < 65536: -1\"\nNode.js will generate and throw RangeError instances immediately as a form\nof argument validation.
A subclass of Error that indicates that an attempt is being made to access a\nvariable that is not defined. Such errors commonly indicate typos in code, or\nan otherwise broken program.
While client code may generate and propagate these errors, in practice, only V8\nwill do so.
\ndoesNotExist;\n// throws ReferenceError, doesNotExist is not a variable in this program.\nUnless an application is dynamically generating and running code,\nReferenceError instances should always be considered a bug in the code\nor its dependencies.
A subclass of Error that indicates that a program is not valid JavaScript.\nThese errors may only be generated and propagated as a result of code\nevaluation. Code evaluation may happen as a result of eval, Function,\nrequire, or vm. These errors are almost always indicative of a broken\nprogram.
try {\n require('vm').runInThisContext('binary ! isNotOk');\n} catch (err) {\n // err will be a SyntaxError\n}\nSyntaxError instances are unrecoverable in the context that created them –\nthey may only be caught by other contexts.
A subclass of Error that indicates that a provided argument is not an\nallowable type. For example, passing a function to a parameter which expects a\nstring would be considered a TypeError.
require('url').parse(() => { });\n// throws TypeError, since it expected a string\nNode.js will generate and throw TypeError instances immediately as a form\nof argument validation.
Applications running in Node.js will generally experience four categories of\nerrors:
\nAssertionErrors are a special class of error that can be triggered when\nNode.js detects an exceptional logic violation that should never occur. These\nare raised typically by the assert module.All JavaScript and System errors raised by Node.js inherit from, or are\ninstances of, the standard JavaScript <Error> class and are guaranteed\nto provide at least the properties available on that class.
", "miscs": [ { "textRaw": "Error Propagation and Interception", "name": "Error Propagation and Interception", "type": "misc", "desc": "Node.js supports several mechanisms for propagating and handling errors that\noccur while an application is running. How these errors are reported and\nhandled depends entirely on the type of Error and the style of the API that is\ncalled.
All JavaScript errors are handled as exceptions that immediately generate\nand throw an error using the standard JavaScript throw mechanism. These\nare handled using the try…catch construct provided by the\nJavaScript language.
// Throws with a ReferenceError because z is not defined.\ntry {\n const m = 1;\n const n = m + z;\n} catch (err) {\n // Handle the error here.\n}\nAny use of the JavaScript throw mechanism will raise an exception that\nmust be handled using try…catch or the Node.js process will exit\nimmediately.
With few exceptions, Synchronous APIs (any blocking method that does not\naccept a callback function, such as fs.readFileSync), will use throw\nto report errors.
Errors that occur within Asynchronous APIs may be reported in multiple ways:
\ncallback function will accept an\nError object passed as the first argument to that function. If that first\nargument is not null and is an instance of Error, then an error occurred\nthat should be handled.const fs = require('fs');\nfs.readFile('a file that does not exist', (err, data) => {\n if (err) {\n console.error('There was an error reading the file!', err);\n return;\n }\n // Otherwise handle the data\n});\nWhen an asynchronous method is called on an object that is an\nEventEmitter, errors can be routed to that object's 'error' event.
const net = require('net');\nconst connection = net.connect('localhost');\n\n// Adding an 'error' event handler to a stream:\nconnection.on('error', (err) => {\n // If the connection is reset by the server, or if it can't\n // connect at all, or on any sort of error encountered by\n // the connection, the error will be sent here.\n console.error(err);\n});\n\nconnection.pipe(process.stdout);\nA handful of typically asynchronous methods in the Node.js API may still\nuse the throw mechanism to raise exceptions that must be handled using\ntry…catch. There is no comprehensive list of such methods; please\nrefer to the documentation of each method to determine the appropriate\nerror handling mechanism required.
The use of the 'error' event mechanism is most common for stream-based\nand event emitter-based APIs, which themselves represent a series of\nasynchronous operations over time (as opposed to a single operation that may\npass or fail).
For all EventEmitter objects, if an 'error' event handler is not\nprovided, the error will be thrown, causing the Node.js process to report an\nuncaught exception and crash unless either: The domain module is\nused appropriately or a handler has been registered for the\n'uncaughtException' event.
const EventEmitter = require('events');\nconst ee = new EventEmitter();\n\nsetImmediate(() => {\n // This will crash the process because no 'error' event\n // handler has been added.\n ee.emit('error', new Error('This will crash'));\n});\nErrors generated in this way cannot be intercepted using try…catch as\nthey are thrown after the calling code has already exited.
Developers must refer to the documentation for each method to determine\nexactly how errors raised by those methods are propagated.
", "miscs": [ { "textRaw": "Error-first callbacks", "name": "Error-first callbacks", "type": "misc", "desc": "Most asynchronous methods exposed by the Node.js core API follow an idiomatic\npattern referred to as an error-first callback. With this pattern, a callback\nfunction is passed to the method as an argument. When the operation either\ncompletes or an error is raised, the callback function is called with the\nError object (if any) passed as the first argument. If no error was raised,\nthe first argument will be passed as null.
const fs = require('fs');\n\nfunction errorFirstCallback(err, data) {\n if (err) {\n console.error('There was an error', err);\n return;\n }\n console.log(data);\n}\n\nfs.readFile('/some/file/that/does-not-exist', errorFirstCallback);\nfs.readFile('/some/file/that/does-exist', errorFirstCallback);\nThe JavaScript try…catch mechanism cannot be used to intercept errors\ngenerated by asynchronous APIs. A common mistake for beginners is to try to\nuse throw inside an error-first callback:
// THIS WILL NOT WORK:\nconst fs = require('fs');\n\ntry {\n fs.readFile('/some/file/that/does-not-exist', (err, data) => {\n // mistaken assumption: throwing here...\n if (err) {\n throw err;\n }\n });\n} catch (err) {\n // This will not catch the throw!\n console.error(err);\n}\nThis will not work because the callback function passed to fs.readFile() is\ncalled asynchronously. By the time the callback has been called, the\nsurrounding code (including the try { } catch (err) { } block will have\nalready exited. Throwing an error inside the callback can crash the Node.js\nprocess in most cases. If domains are enabled, or a handler has been\nregistered with process.on('uncaughtException'), such errors can be\nintercepted.
A JavaScript exception is a value that is thrown as a result of an invalid\noperation or as the target of a throw statement. While it is not required\nthat these values are instances of Error or classes which inherit from\nError, all exceptions thrown by Node.js or the JavaScript runtime will be\ninstances of Error.
Some exceptions are unrecoverable at the JavaScript layer. Such exceptions\nwill always cause the Node.js process to crash. Examples include assert()\nchecks or abort() calls in the C++ layer.
Node.js generates system errors when exceptions occur within its runtime\nenvironment. These usually occur when an application violates an operating\nsystem constraint. For example, a system error will occur if an application\nattempts to read a file that does not exist.
\nSystem errors are usually generated at the syscall level. For a comprehensive\nlist, see the errno(3) man page.
In Node.js, system errors are Error objects with extra properties.
address <string> If present, the address to which a network connection\nfailedcode <string> The string error codedest <string> If present, the file path destination when reporting a file\nsystem errorerrno <number> | <string> The system-provided error numberinfo <Object> If present, extra details about the error conditionmessage <string> A system-provided human-readable description of the errorpath <string> If present, the file path when reporting a file system errorport <number> If present, the network connection port that is not availablesyscall <string> The name of the system call that triggered the errorIf present, error.address is a string describing the address to which a\nnetwork connection failed.
The error.code property is a string representing the error code.
If present, error.dest is the file path destination when reporting a file\nsystem error.
The error.errno property is a number or a string. If it is a number, it is a\nnegative value which corresponds to the error code defined in\nlibuv Error handling. See the libuv errno.h header file\n(deps/uv/include/uv/errno.h in the Node.js source tree) for details. In case\nof a string, it is the same as error.code.
If present, error.info is an object with details about the error condition.
error.message is a system-provided human-readable description of the error.
If present, error.path is a string containing a relevant invalid pathname.
If present, error.port is the network connection port that is not available.
The error.syscall property is a string describing the syscall that failed.
This is a list of system errors commonly-encountered when writing a Node.js\nprogram. For a comprehensive list, see the errno(3) man page.
EACCES (Permission denied): An attempt was made to access a file in a way\nforbidden by its file access permissions.
EADDRINUSE (Address already in use): An attempt to bind a server\n(net, http, or https) to a local address failed due to\nanother server on the local system already occupying that address.
ECONNREFUSED (Connection refused): No connection could be made because the\ntarget machine actively refused it. This usually results from trying to\nconnect to a service that is inactive on the foreign host.
ECONNRESET (Connection reset by peer): A connection was forcibly closed by\na peer. This normally results from a loss of the connection on the remote\nsocket due to a timeout or reboot. Commonly encountered via the http\nand net modules.
EEXIST (File exists): An existing file was the target of an operation that\nrequired that the target not exist.
EISDIR (Is a directory): An operation expected a file, but the given\npathname was a directory.
EMFILE (Too many open files in system): Maximum number of\nfile descriptors allowable on the system has been reached, and\nrequests for another descriptor cannot be fulfilled until at least one\nhas been closed. This is encountered when opening many files at once in\nparallel, especially on systems (in particular, macOS) where there is a low\nfile descriptor limit for processes. To remedy a low limit, run\nulimit -n 2048 in the same shell that will run the Node.js process.
ENOENT (No such file or directory): Commonly raised by fs operations\nto indicate that a component of the specified pathname does not exist — no\nentity (file or directory) could be found by the given path.
ENOTDIR (Not a directory): A component of the given pathname existed, but\nwas not a directory as expected. Commonly raised by fs.readdir.
ENOTEMPTY (Directory not empty): A directory with entries was the target\nof an operation that requires an empty directory — usually fs.unlink.
EPERM (Operation not permitted): An attempt was made to perform an\noperation that requires elevated privileges.
EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is\nno process to read the data. Commonly encountered at the net and\nhttp layers, indicative that the remote side of the stream being\nwritten to has been closed.
ETIMEDOUT (Operation timed out): A connect or send request failed because\nthe connected party did not properly respond after a period of time. Usually\nencountered by http or net — often a sign that a socket.end()\nwas not properly called.
A function argument is being used in a way that suggests that the function\nsignature may be misunderstood. This is thrown by the assert module when the\nmessage parameter in assert.throws(block, message) matches the error message\nthrown by block because that usage suggests that the user believes message\nis the expected message rather than the message the AssertionError will\ndisplay if block does not throw.
An iterable argument (i.e. a value that works with for...of loops) was\nrequired, but not provided to a Node.js API.
A special type of error that can be triggered whenever Node.js detects an\nexceptional logic violation that should never occur. These are raised typically\nby the assert module.
An attempt was made to register something that is not a function as an\nAsyncHooks callback.
The type of an asynchronous resource was invalid. Note that users are also able\nto define their own types if using the public embedder API.
\n", "type": "module", "displayName": "ERR_ASYNC_TYPE" }, { "textRaw": "ERR_BROTLI_COMPRESSION_FAILED", "name": "err_brotli_compression_failed", "desc": "Data passed to a Brotli stream was not successfully compressed.
\n", "type": "module", "displayName": "ERR_BROTLI_COMPRESSION_FAILED" }, { "textRaw": "ERR_BROTLI_INVALID_PARAM", "name": "err_brotli_invalid_param", "desc": "An invalid parameter key was passed during construction of a Brotli stream.
\n", "type": "module", "displayName": "ERR_BROTLI_INVALID_PARAM" }, { "textRaw": "ERR_BUFFER_OUT_OF_BOUNDS", "name": "err_buffer_out_of_bounds", "desc": "An operation outside the bounds of a Buffer was attempted.
An attempt has been made to create a Buffer larger than the maximum allowed\nsize.
The value passed to postMessage() contained an object that is not supported\nfor transferring.
Node.js was unable to watch for the SIGINT signal.
A child process was closed before the parent received a reply.
\n", "type": "module", "displayName": "ERR_CHILD_CLOSED_BEFORE_REPLY" }, { "textRaw": "ERR_CHILD_PROCESS_IPC_REQUIRED", "name": "err_child_process_ipc_required", "desc": "Used when a child process is being forked without specifying an IPC channel.
\n", "type": "module", "displayName": "ERR_CHILD_PROCESS_IPC_REQUIRED" }, { "textRaw": "ERR_CHILD_PROCESS_STDIO_MAXBUFFER", "name": "err_child_process_stdio_maxbuffer", "desc": "Used when the main process is trying to read data from the child process's\nSTDERR/STDOUT, and the data's length is longer than the maxBuffer option.
There was an attempt to use a MessagePort instance in a closed\nstate, usually after .close() has been called.
Console was instantiated without stdout stream, or Console has a\nnon-writable stdout or stderr stream.
A constructor for a class was called without new.
The native call from process.cpuUsage could not be processed.
A client certificate engine was requested that is not supported by the version\nof OpenSSL being used.
\n", "type": "module", "displayName": "ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED" }, { "textRaw": "ERR_CRYPTO_ECDH_INVALID_FORMAT", "name": "err_crypto_ecdh_invalid_format", "desc": "An invalid value for the format argument was passed to the crypto.ECDH()\nclass getPublicKey() method.
An invalid value for the key argument has been passed to the\ncrypto.ECDH() class computeSecret() method. It means that the public\nkey lies outside of the elliptic curve.
An invalid crypto engine identifier was passed to\nrequire('crypto').setEngine().
The --force-fips command-line argument was used but there was an attempt\nto enable or disable FIPS mode in the crypto module.
An attempt was made to enable or disable FIPS mode, but FIPS mode was not\navailable.
\n", "type": "module", "displayName": "ERR_CRYPTO_FIPS_UNAVAILABLE" }, { "textRaw": "ERR_CRYPTO_HASH_DIGEST_NO_UTF16", "name": "err_crypto_hash_digest_no_utf16", "desc": "The UTF-16 encoding was used with hash.digest(). While the\nhash.digest() method does allow an encoding argument to be passed in,\ncausing the method to return a string rather than a Buffer, the UTF-16\nencoding (e.g. ucs or utf16le) is not supported.
hash.digest() was called multiple times. The hash.digest() method must\nbe called no more than one time per instance of a Hash object.
hash.update() failed for any reason. This should rarely, if ever, happen.
The selected public or private key encoding is incompatible with other options.
\n", "type": "module", "displayName": "ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS" }, { "textRaw": "ERR_CRYPTO_INVALID_DIGEST", "name": "err_crypto_invalid_digest", "desc": "An invalid crypto digest algorithm was specified.
\n", "type": "module", "displayName": "ERR_CRYPTO_INVALID_DIGEST" }, { "textRaw": "ERR_CRYPTO_INVALID_STATE", "name": "err_crypto_invalid_state", "desc": "A crypto method was used on an object that was in an invalid state. For\ninstance, calling cipher.getAuthTag() before calling cipher.final().
The PBKDF2 algorithm failed for unspecified reasons. OpenSSL does not provide\nmore details and therefore neither does Node.js.
\n", "type": "module", "displayName": "ERR_CRYPTO_PBKDF2_ERROR" }, { "textRaw": "ERR_CRYPTO_SCRYPT_INVALID_PARAMETER", "name": "err_crypto_scrypt_invalid_parameter", "desc": "One or more crypto.scrypt() or crypto.scryptSync() parameters are\noutside their legal range.
Node.js was compiled without scrypt support. Not possible with the official\nrelease binaries but can happen with custom builds, including distro builds.
A signing key was not provided to the sign.sign() method.
crypto.timingSafeEqual() was called with Buffer, TypedArray, or\nDataView arguments of different lengths.
c-ares failed to set the DNS server.
The domain module was not usable since it could not establish the required\nerror handling hooks, because\nprocess.setUncaughtExceptionCaptureCallback() had been called at an\nearlier point in time.
process.setUncaughtExceptionCaptureCallback() could not be called\nbecause the domain module has been loaded at an earlier point in time.
The stack trace is extended to include the point in time at which the\ndomain module had been loaded.
Data provided to util.TextDecoder() API was invalid according to the encoding\nprovided.
Encoding provided to util.TextDecoder() API was not one of the\nWHATWG Supported Encodings.
A Promise that was callbackified via util.callbackify() was rejected with a\nfalsy value.
An attempt has been made to read a file whose size is larger than the maximum\nallowed size for a Buffer.
An invalid symlink type was passed to the fs.symlink() or\nfs.symlinkSync() methods.
An attempt was made to add more headers after the headers had already been sent.
\n", "type": "module", "displayName": "ERR_HTTP_HEADERS_SENT" }, { "textRaw": "ERR_HTTP_INVALID_HEADER_VALUE", "name": "err_http_invalid_header_value", "desc": "An invalid HTTP header value was specified.
\n", "type": "module", "displayName": "ERR_HTTP_INVALID_HEADER_VALUE" }, { "textRaw": "ERR_HTTP_INVALID_STATUS_CODE", "name": "err_http_invalid_status_code", "desc": "Status code was outside the regular status code range (100-999).
\n", "type": "module", "displayName": "ERR_HTTP_INVALID_STATUS_CODE" }, { "textRaw": "ERR_HTTP_TRAILER_INVALID", "name": "err_http_trailer_invalid", "desc": "The Trailer header was set even though the transfer encoding does not support\nthat.
HTTP/2 ALTSVC frames require a valid origin.
\n", "type": "module", "displayName": "ERR_HTTP2_ALTSVC_INVALID_ORIGIN" }, { "textRaw": "ERR_HTTP2_ALTSVC_LENGTH", "name": "err_http2_altsvc_length", "desc": "HTTP/2 ALTSVC frames are limited to a maximum of 16,382 payload bytes.
\n", "type": "module", "displayName": "ERR_HTTP2_ALTSVC_LENGTH" }, { "textRaw": "ERR_HTTP2_CONNECT_AUTHORITY", "name": "err_http2_connect_authority", "desc": "For HTTP/2 requests using the CONNECT method, the :authority pseudo-header\nis required.
For HTTP/2 requests using the CONNECT method, the :path pseudo-header is\nforbidden.
For HTTP/2 requests using the CONNECT method, the :scheme pseudo-header is\nforbidden.
A non-specific HTTP/2 error has occurred.
\n", "type": "module", "displayName": "ERR_HTTP2_ERROR" }, { "textRaw": "ERR_HTTP2_GOAWAY_SESSION", "name": "err_http2_goaway_session", "desc": "New HTTP/2 Streams may not be opened after the Http2Session has received a\nGOAWAY frame from the connected peer.
An additional headers was specified after an HTTP/2 response was initiated.
\n", "type": "module", "displayName": "ERR_HTTP2_HEADERS_AFTER_RESPOND" }, { "textRaw": "ERR_HTTP2_HEADERS_SENT", "name": "err_http2_headers_sent", "desc": "An attempt was made to send multiple response headers.
\n", "type": "module", "displayName": "ERR_HTTP2_HEADERS_SENT" }, { "textRaw": "ERR_HTTP2_HEADER_SINGLE_VALUE", "name": "err_http2_header_single_value", "desc": "Multiple values were provided for an HTTP/2 header field that was required to\nhave only a single value.
\n", "type": "module", "displayName": "ERR_HTTP2_HEADER_SINGLE_VALUE" }, { "textRaw": "ERR_HTTP2_INFO_STATUS_NOT_ALLOWED", "name": "err_http2_info_status_not_allowed", "desc": "Informational HTTP status codes (1xx) may not be set as the response status\ncode on HTTP/2 responses.
HTTP/1 connection specific headers are forbidden to be used in HTTP/2\nrequests and responses.
\n", "type": "module", "displayName": "ERR_HTTP2_INVALID_CONNECTION_HEADERS" }, { "textRaw": "ERR_HTTP2_INVALID_HEADER_VALUE", "name": "err_http2_invalid_header_value", "desc": "An invalid HTTP/2 header value was specified.
\n", "type": "module", "displayName": "ERR_HTTP2_INVALID_HEADER_VALUE" }, { "textRaw": "ERR_HTTP2_INVALID_INFO_STATUS", "name": "err_http2_invalid_info_status", "desc": "An invalid HTTP informational status code has been specified. Informational\nstatus codes must be an integer between 100 and 199 (inclusive).
HTTP/2 ORIGIN frames require a valid origin.
Input Buffer and Uint8Array instances passed to the\nhttp2.getUnpackedSettings() API must have a length that is a multiple of\nsix.
Only valid HTTP/2 pseudoheaders (:status, :path, :authority, :scheme,\nand :method) may be used.
An action was performed on an Http2Session object that had already been\ndestroyed.
An invalid value has been specified for an HTTP/2 setting.
\n", "type": "module", "displayName": "ERR_HTTP2_INVALID_SETTING_VALUE" }, { "textRaw": "ERR_HTTP2_INVALID_STREAM", "name": "err_http2_invalid_stream", "desc": "An operation was performed on a stream that had already been destroyed.
\n", "type": "module", "displayName": "ERR_HTTP2_INVALID_STREAM" }, { "textRaw": "ERR_HTTP2_MAX_PENDING_SETTINGS_ACK", "name": "err_http2_max_pending_settings_ack", "desc": "Whenever an HTTP/2 SETTINGS frame is sent to a connected peer, the peer is\nrequired to send an acknowledgment that it has received and applied the new\nSETTINGS. By default, a maximum number of unacknowledged SETTINGS frames may\nbe sent at any given time. This error code is used when that limit has been\nreached.
An attempt was made to initiate a new push stream from within a push stream.\nNested push streams are not permitted.
\n", "type": "module", "displayName": "ERR_HTTP2_NESTED_PUSH" }, { "textRaw": "ERR_HTTP2_NO_SOCKET_MANIPULATION", "name": "err_http2_no_socket_manipulation", "desc": "An attempt was made to directly manipulate (read, write, pause, resume, etc.) a\nsocket attached to an Http2Session.
HTTP/2 ORIGIN frames are limited to a length of 16382 bytes.
The number of streams created on a single HTTP/2 session reached the maximum\nlimit.
\n", "type": "module", "displayName": "ERR_HTTP2_OUT_OF_STREAMS" }, { "textRaw": "ERR_HTTP2_PAYLOAD_FORBIDDEN", "name": "err_http2_payload_forbidden", "desc": "A message payload was specified for an HTTP response code for which a payload is\nforbidden.
\n", "type": "module", "displayName": "ERR_HTTP2_PAYLOAD_FORBIDDEN" }, { "textRaw": "ERR_HTTP2_PING_CANCEL", "name": "err_http2_ping_cancel", "desc": "An HTTP/2 ping was canceled.
\n", "type": "module", "displayName": "ERR_HTTP2_PING_CANCEL" }, { "textRaw": "ERR_HTTP2_PING_LENGTH", "name": "err_http2_ping_length", "desc": "HTTP/2 ping payloads must be exactly 8 bytes in length.
\n", "type": "module", "displayName": "ERR_HTTP2_PING_LENGTH" }, { "textRaw": "ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED", "name": "err_http2_pseudoheader_not_allowed", "desc": "An HTTP/2 pseudo-header has been used inappropriately. Pseudo-headers are header\nkey names that begin with the : prefix.
An attempt was made to create a push stream, which had been disabled by the\nclient.
\n", "type": "module", "displayName": "ERR_HTTP2_PUSH_DISABLED" }, { "textRaw": "ERR_HTTP2_SEND_FILE", "name": "err_http2_send_file", "desc": "An attempt was made to use the Http2Stream.prototype.responseWithFile() API to\nsend a directory.
An attempt was made to use the Http2Stream.prototype.responseWithFile() API to\nsend something other than a regular file, but offset or length options were\nprovided.
The Http2Session closed with a non-zero error code.
The Http2Session settings canceled.
An attempt was made to connect a Http2Session object to a net.Socket or\ntls.TLSSocket that had already been bound to another Http2Session object.
An attempt was made to use the socket property of an Http2Session that\nhas already been closed.
Use of the 101 Informational status code is forbidden in HTTP/2.
An invalid HTTP status code has been specified. Status codes must be an integer\nbetween 100 and 599 (inclusive).
An Http2Stream was destroyed before any data was transmitted to the connected\npeer.
A non-zero error code was been specified in an RST_STREAM frame.
When setting the priority for an HTTP/2 stream, the stream may be marked as\na dependency for a parent stream. This error code is used when an attempt is\nmade to mark a stream and dependent of itself.
\n", "type": "module", "displayName": "ERR_HTTP2_STREAM_SELF_DEPENDENCY" }, { "textRaw": "ERR_HTTP2_TRAILERS_ALREADY_SENT", "name": "err_http2_trailers_already_sent", "desc": "Trailing headers have already been sent on the Http2Stream.
The http2stream.sendTrailers() method cannot be called until after the\n'wantTrailers' event is emitted on an Http2Stream object. The\n'wantTrailers' event will only be emitted if the waitForTrailers option\nis set for the Http2Stream.
http2.connect() was passed a URL that uses any protocol other than http: or\nhttps:.
A given index was out of the accepted range (e.g. negative offsets).
\n", "type": "module", "displayName": "ERR_INDEX_OUT_OF_RANGE" }, { "textRaw": "ERR_INSPECTOR_ALREADY_CONNECTED", "name": "err_inspector_already_connected", "desc": "While using the inspector module, an attempt was made to connect when the\ninspector was already connected.
While using the inspector module, an attempt was made to use the inspector\nafter the session had already closed.
The inspector module is not available for use.
While using the inspector module, an attempt was made to use the inspector\nbefore it was connected.
The provided address family is not understood by the Node.js API.
\n", "type": "module", "displayName": "ERR_INVALID_ADDRESS_FAMILY" }, { "textRaw": "ERR_INVALID_ARG_TYPE", "name": "err_invalid_arg_type", "desc": "An argument of the wrong type was passed to a Node.js API.
\n", "type": "module", "displayName": "ERR_INVALID_ARG_TYPE" }, { "textRaw": "ERR_INVALID_ARG_VALUE", "name": "err_invalid_arg_value", "desc": "An invalid or unsupported value was passed for a given argument.
\n", "type": "module", "displayName": "ERR_INVALID_ARG_VALUE" }, { "textRaw": "ERR_INVALID_ARRAY_LENGTH", "name": "err_invalid_array_length", "desc": "An array was not of the expected length or in a valid range.
\n", "type": "module", "displayName": "ERR_INVALID_ARRAY_LENGTH" }, { "textRaw": "ERR_INVALID_ASYNC_ID", "name": "err_invalid_async_id", "desc": "An invalid asyncId or triggerAsyncId was passed using AsyncHooks. An id\nless than -1 should never happen.
A swap was performed on a Buffer but its size was not compatible with the\noperation.
A callback function was required but was not been provided to a Node.js API.
\n", "type": "module", "displayName": "ERR_INVALID_CALLBACK" }, { "textRaw": "ERR_INVALID_CHAR", "name": "err_invalid_char", "desc": "Invalid characters were detected in headers.
\n", "type": "module", "displayName": "ERR_INVALID_CHAR" }, { "textRaw": "ERR_INVALID_CURSOR_POS", "name": "err_invalid_cursor_pos", "desc": "A cursor on a given stream cannot be moved to a specified row without a\nspecified column.
\n", "type": "module", "displayName": "ERR_INVALID_CURSOR_POS" }, { "textRaw": "ERR_INVALID_DOMAIN_NAME", "name": "err_invalid_domain_name", "desc": "hostname can not be parsed from a provided URL.
A file descriptor ('fd') was not valid (e.g. it was a negative value).
\n", "type": "module", "displayName": "ERR_INVALID_FD" }, { "textRaw": "ERR_INVALID_FD_TYPE", "name": "err_invalid_fd_type", "desc": "A file descriptor ('fd') type was not valid.
\n", "type": "module", "displayName": "ERR_INVALID_FD_TYPE" }, { "textRaw": "ERR_INVALID_FILE_URL_HOST", "name": "err_invalid_file_url_host", "desc": "A Node.js API that consumes file: URLs (such as certain functions in the\nfs module) encountered a file URL with an incompatible host. This\nsituation can only occur on Unix-like systems where only localhost or an empty\nhost is supported.
A Node.js API that consumes file: URLs (such as certain functions in the\nfs module) encountered a file URL with an incompatible path. The exact\nsemantics for determining whether a path can be used is platform-dependent.
An attempt was made to send an unsupported \"handle\" over an IPC communication\nchannel to a child process. See subprocess.send() and process.send() for\nmore information.
An invalid HTTP token was supplied.
\n", "type": "module", "displayName": "ERR_INVALID_HTTP_TOKEN" }, { "textRaw": "ERR_INVALID_IP_ADDRESS", "name": "err_invalid_ip_address", "desc": "An IP address is not valid.
\n", "type": "module", "displayName": "ERR_INVALID_IP_ADDRESS" }, { "textRaw": "ERR_INVALID_OPT_VALUE", "name": "err_invalid_opt_value", "desc": "An invalid or unexpected value was passed in an options object.
\n", "type": "module", "displayName": "ERR_INVALID_OPT_VALUE" }, { "textRaw": "ERR_INVALID_OPT_VALUE_ENCODING", "name": "err_invalid_opt_value_encoding", "desc": "An invalid or unknown file encoding was passed.
\n", "type": "module", "displayName": "ERR_INVALID_OPT_VALUE_ENCODING" }, { "textRaw": "ERR_INVALID_PERFORMANCE_MARK", "name": "err_invalid_performance_mark", "desc": "While using the Performance Timing API (perf_hooks), a performance mark is\ninvalid.
An invalid options.protocol was passed.
Both breakEvalOnSigint and eval options were set in the REPL config, which\nis not supported.
Thrown in case a function option does not provide a valid value for one of its\nreturned object properties on execution.
\n", "type": "module", "displayName": "ERR_INVALID_RETURN_PROPERTY" }, { "textRaw": "ERR_INVALID_RETURN_PROPERTY_VALUE", "name": "err_invalid_return_property_value", "desc": "Thrown in case a function option does not provide an expected value\ntype for one of its returned object properties on execution.
\n", "type": "module", "displayName": "ERR_INVALID_RETURN_PROPERTY_VALUE" }, { "textRaw": "ERR_INVALID_RETURN_VALUE", "name": "err_invalid_return_value", "desc": "Thrown in case a function option does not return an expected value\ntype on execution, such as when a function is expected to return a promise.
\n", "type": "module", "displayName": "ERR_INVALID_RETURN_VALUE" }, { "textRaw": "ERR_INVALID_SYNC_FORK_INPUT", "name": "err_invalid_sync_fork_input", "desc": "A Buffer, TypedArray, DataView or string was provided as stdio input to\nan asynchronous fork. See the documentation for the child_process module\nfor more information.
A Node.js API function was called with an incompatible this value.
const urlSearchParams = new URLSearchParams('foo=bar&baz=new');\n\nconst buf = Buffer.alloc(1);\nurlSearchParams.has.call(buf, 'foo');\n// Throws a TypeError with code 'ERR_INVALID_THIS'\nAn invalid transfer object was passed to postMessage().
An element in the iterable provided to the WHATWG\nURLSearchParams constructor did not\nrepresent a [name, value] tuple – that is, if an element is not iterable, or\ndoes not consist of exactly two elements.
An invalid URI was passed.
\n", "type": "module", "displayName": "ERR_INVALID_URI" }, { "textRaw": "ERR_INVALID_URL", "name": "err_invalid_url", "desc": "An invalid URL was passed to the WHATWG\nURL constructor to be parsed. The thrown error object\ntypically has an additional property 'input' that contains the URL that failed\nto parse.
An attempt was made to use a URL of an incompatible scheme (protocol) for a\nspecific purpose. It is only used in the WHATWG URL API support in the\nfs module (which only accepts URLs with 'file' scheme), but may be used\nin other Node.js APIs as well in the future.
An attempt was made to use an IPC communication channel that was already closed.
\n", "type": "module", "displayName": "ERR_IPC_CHANNEL_CLOSED" }, { "textRaw": "ERR_IPC_DISCONNECTED", "name": "err_ipc_disconnected", "desc": "An attempt was made to disconnect an IPC communication channel that was already\ndisconnected. See the documentation for the child_process module\nfor more information.
An attempt was made to create a child Node.js process using more than one IPC\ncommunication channel. See the documentation for the child_process module\nfor more information.
An attempt was made to open an IPC communication channel with a synchronously\nforked Node.js process. See the documentation for the child_process module\nfor more information.
An attempt was made to allocate memory (usually in the C++ layer) but it\nfailed.
\n", "type": "module", "displayName": "ERR_MEMORY_ALLOCATION_FAILED" }, { "textRaw": "ERR_METHOD_NOT_IMPLEMENTED", "name": "err_method_not_implemented", "desc": "A method is required but not implemented.
\n", "type": "module", "displayName": "ERR_METHOD_NOT_IMPLEMENTED" }, { "textRaw": "ERR_MISSING_ARGS", "name": "err_missing_args", "desc": "A required argument of a Node.js API was not passed. This is only used for\nstrict compliance with the API specification (which in some cases may accept\nfunc(undefined) but not func()). In most native Node.js APIs,\nfunc(undefined) and func() are treated identically, and the\nERR_INVALID_ARG_TYPE error code may be used instead.
An ES6 module loader hook specified format: 'dynamic' but did not provide\na dynamicInstantiate hook.
A MessagePort was found in the object passed to a postMessage() call,\nbut not provided in the transferList for that call.
An ES6 module could not be resolved.
\n", "type": "module", "displayName": "ERR_MISSING_MODULE" }, { "textRaw": "ERR_MISSING_PLATFORM_FOR_WORKER", "name": "err_missing_platform_for_worker", "desc": "The V8 platform used by this instance of Node.js does not support creating\nWorkers. This is caused by lack of embedder support for Workers. In particular,\nthis error will not occur with standard builds of Node.js.
\n", "type": "module", "displayName": "ERR_MISSING_PLATFORM_FOR_WORKER" }, { "textRaw": "ERR_MODULE_RESOLUTION_LEGACY", "name": "err_module_resolution_legacy", "stability": 1, "stabilityText": "Experimental", "desc": "A failure occurred resolving imports in an ES6 module.
\n", "type": "module", "displayName": "ERR_MODULE_RESOLUTION_LEGACY" }, { "textRaw": "ERR_MULTIPLE_CALLBACK", "name": "err_multiple_callback", "desc": "A callback was called more than once.
\nA callback is almost always meant to only be called once as the query\ncan either be fulfilled or rejected but not both at the same time. The latter\nwould be possible by calling a callback more than once.
\n", "type": "module", "displayName": "ERR_MULTIPLE_CALLBACK" }, { "textRaw": "ERR_NAPI_CONS_FUNCTION", "name": "err_napi_cons_function", "desc": "While using N-API, a constructor passed was not a function.
While calling napi_create_dataview(), a given offset was outside the bounds\nof the dataview or offset + length was larger than a length of given buffer.
While calling napi_create_typedarray(), the provided offset was not a\nmultiple of the element size.
While calling napi_create_typedarray(), (length * size_of_element) + byte_offset was larger than the length of given buffer.
An error occurred while invoking the JavaScript portion of the thread-safe\nfunction.
\n", "type": "module", "displayName": "ERR_NAPI_TSFN_CALL_JS" }, { "textRaw": "ERR_NAPI_TSFN_GET_UNDEFINED", "name": "err_napi_tsfn_get_undefined", "desc": "An error occurred while attempting to retrieve the JavaScript undefined\nvalue.
On the main thread, values are removed from the queue associated with the\nthread-safe function in an idle loop. This error indicates that an error\nhas occurred when attempting to start the loop.
\n", "type": "module", "displayName": "ERR_NAPI_TSFN_START_IDLE_LOOP" }, { "textRaw": "ERR_NAPI_TSFN_STOP_IDLE_LOOP", "name": "err_napi_tsfn_stop_idle_loop", "desc": "Once no more items are left in the queue, the idle loop must be suspended. This\nerror indicates that the idle loop has failed to stop.
\n", "type": "module", "displayName": "ERR_NAPI_TSFN_STOP_IDLE_LOOP" }, { "textRaw": "ERR_NO_CRYPTO", "name": "err_no_crypto", "desc": "An attempt was made to use crypto features while Node.js was not compiled with\nOpenSSL crypto support.
\n", "type": "module", "displayName": "ERR_NO_CRYPTO" }, { "textRaw": "ERR_NO_ICU", "name": "err_no_icu", "desc": "An attempt was made to use features that require ICU, but Node.js was not\ncompiled with ICU support.
\n", "type": "module", "displayName": "ERR_NO_ICU" }, { "textRaw": "ERR_NO_LONGER_SUPPORTED", "name": "err_no_longer_supported", "desc": "A Node.js API was called in an unsupported manner, such as\nBuffer.write(string, encoding, offset[, length]).
A given value is out of the accepted range.
\n", "type": "module", "displayName": "ERR_OUT_OF_RANGE" }, { "textRaw": "ERR_REQUIRE_ESM", "name": "err_require_esm", "stability": 1, "stabilityText": "Experimental", "desc": "An attempt was made to require() an ES6 module.
Script execution was interrupted by SIGINT (For example, when Ctrl+C was\npressed).
The server.listen() method was called while a net.Server was already\nlistening. This applies to all instances of net.Server, including HTTP, HTTPS,\nand HTTP/2 Server instances.
The server.close() method was called when a net.Server was not\nrunning. This applies to all instances of net.Server, including HTTP, HTTPS,\nand HTTP/2 Server instances.
An attempt was made to bind a socket that has already been bound.
\n", "type": "module", "displayName": "ERR_SOCKET_ALREADY_BOUND" }, { "textRaw": "ERR_SOCKET_BAD_BUFFER_SIZE", "name": "err_socket_bad_buffer_size", "desc": "An invalid (negative) size was passed for either the recvBufferSize or\nsendBufferSize options in dgram.createSocket().
An API function expecting a port >= 0 and < 65536 received an invalid value.
\n", "type": "module", "displayName": "ERR_SOCKET_BAD_PORT" }, { "textRaw": "ERR_SOCKET_BAD_TYPE", "name": "err_socket_bad_type", "desc": "An API function expecting a socket type (udp4 or udp6) received an invalid\nvalue.
While using dgram.createSocket(), the size of the receive or send Buffer\ncould not be determined.
Data could be sent on a socket.
\n", "type": "module", "displayName": "ERR_SOCKET_CANNOT_SEND" }, { "textRaw": "ERR_SOCKET_CLOSED", "name": "err_socket_closed", "desc": "An attempt was made to operate on an already closed socket.
\n", "type": "module", "displayName": "ERR_SOCKET_CLOSED" }, { "textRaw": "ERR_SOCKET_DGRAM_NOT_RUNNING", "name": "err_socket_dgram_not_running", "desc": "A call was made and the UDP subsystem was not running.
\n", "type": "module", "displayName": "ERR_SOCKET_DGRAM_NOT_RUNNING" }, { "textRaw": "ERR_STREAM_CANNOT_PIPE", "name": "err_stream_cannot_pipe", "desc": "An attempt was made to call stream.pipe() on a Writable stream.
A stream method was called that cannot complete because the stream was\ndestroyed using stream.destroy().
An attempt was made to call stream.write() with a null chunk.
An error returned by stream.finished() and stream.pipeline(), when a stream\nor a pipeline ends non gracefully with no explicit error.
An attempt was made to call stream.push() after a null(EOF) had been\npushed to the stream.
An attempt was made to call stream.unshift() after the 'end' event was\nemitted.
Prevents an abort if a string decoder was set on the Socket or if the decoder\nis in objectMode.
const Socket = require('net').Socket;\nconst instance = new Socket();\n\ninstance.setEncoding('utf8');\nAn attempt was made to call stream.write() after stream.end() has been\ncalled.
An attempt has been made to create a string longer than the maximum allowed\nlength.
\n", "type": "module", "displayName": "ERR_STRING_TOO_LONG" }, { "textRaw": "ERR_SYSTEM_ERROR", "name": "err_system_error", "desc": "An unspecified or non-specific system error has occurred within the Node.js\nprocess. The error object will have an err.info object property with\nadditional details.
While using TLS, the hostname/IP of the peer did not match any of the\nsubjectAltNames in its certificate.
While using TLS, the parameter offered for the Diffie-Hellman (DH)\nkey-agreement protocol is too small. By default, the key length must be greater\nthan or equal to 1024 bits to avoid vulnerabilities, even though it is strongly\nrecommended to use 2048 bits or larger for stronger security.
A TLS/SSL handshake timed out. In this case, the server must also abort the\nconnection.
\n", "type": "module", "displayName": "ERR_TLS_HANDSHAKE_TIMEOUT" }, { "textRaw": "ERR_TLS_INVALID_PROTOCOL_VERSION", "name": "err_tls_invalid_protocol_version", "desc": "Valid TLS protocol versions are 'TLSv1', 'TLSv1.1', or 'TLSv1.2'.
Attempting to set a TLS protocol minVersion or maxVersion conflicts with an\nattempt to set the secureProtocol explicitly. Use one mechanism or the other.
An attempt to renegotiate the TLS session failed.
\n", "type": "module", "displayName": "ERR_TLS_RENEGOTIATE" }, { "textRaw": "ERR_TLS_RENEGOTIATION_DISABLED", "name": "err_tls_renegotiation_disabled", "desc": "An attempt was made to renegotiate TLS on a socket instance with TLS disabled.
\n", "type": "module", "displayName": "ERR_TLS_RENEGOTIATION_DISABLED" }, { "textRaw": "ERR_TLS_REQUIRED_SERVER_NAME", "name": "err_tls_required_server_name", "desc": "While using TLS, the server.addContext() method was called without providing\na hostname in the first parameter.
An excessive amount of TLS renegotiations is detected, which is a potential\nvector for denial-of-service attacks.
\n", "type": "module", "displayName": "ERR_TLS_SESSION_ATTACK" }, { "textRaw": "ERR_TLS_SNI_FROM_SERVER", "name": "err_tls_sni_from_server", "desc": "An attempt was made to issue Server Name Indication from a TLS server-side\nsocket, which is only valid from a client.
\n", "type": "module", "displayName": "ERR_TLS_SNI_FROM_SERVER" }, { "textRaw": "ERR_TRACE_EVENTS_CATEGORY_REQUIRED", "name": "err_trace_events_category_required", "desc": "The trace_events.createTracing() method requires at least one trace event\ncategory.
The trace_events module could not be loaded because Node.js was compiled with\nthe --without-v8-platform flag.
A SharedArrayBuffer whose memory is not managed by the JavaScript engine\nor by Node.js was encountered during serialization. Such a SharedArrayBuffer\ncannot be serialized.
This can only happen when native addons create SharedArrayBuffers in\n\"externalized\" mode, or put existing SharedArrayBuffer into externalized mode.
A Transform stream finished while it was still transforming.
A Transform stream finished with data still in the write buffer.
The initialization of a TTY failed due to a system error.
\n", "type": "module", "displayName": "ERR_TTY_INIT_FAILED" }, { "textRaw": "ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET", "name": "err_uncaught_exception_capture_already_set", "desc": "process.setUncaughtExceptionCaptureCallback() was called twice,\nwithout first resetting the callback to null.
This error is designed to prevent accidentally overwriting a callback registered\nfrom another module.
\n", "type": "module", "displayName": "ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET" }, { "textRaw": "ERR_UNESCAPED_CHARACTERS", "name": "err_unescaped_characters", "desc": "A string that contained unescaped characters was received.
\n", "type": "module", "displayName": "ERR_UNESCAPED_CHARACTERS" }, { "textRaw": "ERR_UNHANDLED_ERROR", "name": "err_unhandled_error", "desc": "An unhandled error occurred (for instance, when an 'error' event is emitted\nby an EventEmitter but an 'error' handler is not registered).
Used to identify a specific kind of internal Node.js error that should not\ntypically be triggered by user code. Instances of this error point to an\ninternal bug within the Node.js binary itself.
\n", "type": "module", "displayName": "ERR_UNKNOWN_BUILTIN_MODULE" }, { "textRaw": "ERR_UNKNOWN_ENCODING", "name": "err_unknown_encoding", "desc": "An invalid or unknown encoding option was passed to an API.
\n", "type": "module", "displayName": "ERR_UNKNOWN_ENCODING" }, { "textRaw": "ERR_UNKNOWN_FILE_EXTENSION", "name": "err_unknown_file_extension", "stability": 1, "stabilityText": "Experimental", "desc": "An attempt was made to load a module with an unknown or unsupported file\nextension.
\n", "type": "module", "displayName": "ERR_UNKNOWN_FILE_EXTENSION" }, { "textRaw": "ERR_UNKNOWN_MODULE_FORMAT", "name": "err_unknown_module_format", "stability": 1, "stabilityText": "Experimental", "desc": "An attempt was made to load a module with an unknown or unsupported format.
\n", "type": "module", "displayName": "ERR_UNKNOWN_MODULE_FORMAT" }, { "textRaw": "ERR_UNKNOWN_SIGNAL", "name": "err_unknown_signal", "desc": "An invalid or unknown process signal was passed to an API expecting a valid\nsignal (such as subprocess.kill()).
An attempt was made to launch a Node.js process with an unknown stdin file\ntype. This error is usually an indication of a bug within Node.js itself,\nalthough it is possible for user code to trigger it.
An attempt was made to launch a Node.js process with an unknown stdout or\nstderr file type. This error is usually an indication of a bug within Node.js\nitself, although it is possible for user code to trigger it.
The V8 BreakIterator API was used but the full ICU data set is not installed.
While using the Performance Timing API (perf_hooks), no valid performance\nentry types were found.
A dynamic import callback was not specified.
\n", "type": "module", "displayName": "ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING" }, { "textRaw": "ERR_VM_MODULE_ALREADY_LINKED", "name": "err_vm_module_already_linked", "desc": "The module attempted to be linked is not eligible for linking, because of one of\nthe following reasons:
\nlinkingStatus is 'linked')linkingStatus is 'linking')linkingStatus is 'errored')The module being returned from the linker function is from a different context\nthan the parent module. Linked modules must share the same context.
\n", "type": "module", "displayName": "ERR_VM_MODULE_DIFFERENT_CONTEXT" }, { "textRaw": "ERR_VM_MODULE_LINKING_ERRORED", "name": "err_vm_module_linking_errored", "desc": "The linker function returned a module for which linking has failed.
\n", "type": "module", "displayName": "ERR_VM_MODULE_LINKING_ERRORED" }, { "textRaw": "ERR_VM_MODULE_NOT_LINKED", "name": "err_vm_module_not_linked", "desc": "The module must be successfully linked before instantiation.
\n", "type": "module", "displayName": "ERR_VM_MODULE_NOT_LINKED" }, { "textRaw": "ERR_VM_MODULE_NOT_MODULE", "name": "err_vm_module_not_module", "desc": "The fulfilled value of a linking promise is not a vm.SourceTextModule object.
The current module's status does not allow for this operation. The specific\nmeaning of the error depends on the specific function.
\n", "type": "module", "displayName": "ERR_VM_MODULE_STATUS" }, { "textRaw": "ERR_WORKER_PATH", "name": "err_worker_path", "desc": "The path for the main script of a worker is neither an absolute path\nnor a relative path starting with ./ or ../.
All attempts at serializing an uncaught exception from a worker thread failed.
\n", "type": "module", "displayName": "ERR_WORKER_UNSERIALIZABLE_ERROR" }, { "textRaw": "ERR_WORKER_UNSUPPORTED_EXTENSION", "name": "err_worker_unsupported_extension", "desc": "The pathname used for the main script of a worker has an\nunknown file extension.
\n", "type": "module", "displayName": "ERR_WORKER_UNSUPPORTED_EXTENSION" }, { "textRaw": "ERR_ZLIB_INITIALIZATION_FAILED", "name": "err_zlib_initialization_failed", "desc": "Creation of a zlib object failed due to incorrect configuration.
Too much HTTP header data was received. In order to protect against malicious or\nmalconfigured clients, if more than 8KB of HTTP header data is received then\nHTTP parsing will abort without a request or response object being created, and\nan Error with this code will be emitted.
A module file could not be resolved while attempting a require() or\nimport operation.
Used when a failure occurs sending an individual frame on the HTTP/2\nsession.
\n", "type": "module", "displayName": "ERR_HTTP2_FRAME_ERROR" }, { "textRaw": "ERR_HTTP2_HEADERS_OBJECT", "name": "err_http2_headers_object", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "Used when an HTTP/2 Headers Object is expected.
\n", "type": "module", "displayName": "ERR_HTTP2_HEADERS_OBJECT" }, { "textRaw": "ERR_HTTP2_HEADER_REQUIRED", "name": "err_http2_header_required", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "Used when a required header is missing in an HTTP/2 message.
\n", "type": "module", "displayName": "ERR_HTTP2_HEADER_REQUIRED" }, { "textRaw": "ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND", "name": "err_http2_info_headers_after_respond", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "HTTP/2 informational headers must only be sent prior to calling the\nHttp2Stream.prototype.respond() method.
Used when an action has been performed on an HTTP/2 Stream that has already\nbeen closed.
\n", "type": "module", "displayName": "ERR_HTTP2_STREAM_CLOSED" }, { "textRaw": "ERR_HTTP_INVALID_CHAR", "name": "err_http_invalid_char", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "Used when an invalid character is found in an HTTP response status message\n(reason phrase).
\n", "type": "module", "displayName": "ERR_HTTP_INVALID_CHAR" }, { "textRaw": "ERR_NAPI_CONS_PROTOTYPE_OBJECT", "name": "err_napi_cons_prototype_object", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "Used by the N-API when Constructor.prototype is not an object.
Used generically to identify that an operation caused an out of memory\ncondition.
\n", "type": "module", "displayName": "ERR_OUTOFMEMORY" }, { "textRaw": "ERR_PARSE_HISTORY_DATA", "name": "err_parse_history_data", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "The repl module was unable to parse data from the REPL history file.
An attempt was made to close the process.stderr stream. By design, Node.js\ndoes not allow stdout or stderr streams to be closed by user code.
An attempt was made to close the process.stdout stream. By design, Node.js\ndoes not allow stdout or stderr streams to be closed by user code.
Used when an attempt is made to use a readable stream that has not implemented\nreadable._read().
Used when a TLS renegotiation request has failed in a non-specific way.
\n", "type": "module", "displayName": "ERR_TLS_RENEGOTIATION_FAILED" }, { "textRaw": "ERR_UNKNOWN_BUILTIN_MODULE", "name": "err_unknown_builtin_module", "meta": { "added": [ "v8.0.0" ], "removed": [ "v9.0.0" ], "changes": [] }, "desc": "The 'ERR_UNKNOWN_BUILTIN_MODULE' error code is used to identify a specific\nkind of internal Node.js error that should not typically be triggered by user\ncode. Instances of this error point to an internal bug within the Node.js\nbinary itself.
Used when a given value is out of the accepted range.
\n", "type": "module", "displayName": "ERR_VALUE_OUT_OF_RANGE" }, { "textRaw": "ERR_ZLIB_BINDING_CLOSED", "name": "err_zlib_binding_closed", "meta": { "added": [ "v9.0.0" ], "removed": [ "v10.0.0" ], "changes": [] }, "desc": "Used when an attempt is made to use a zlib object after it has already been\nclosed.
These errors have never been released, but had been present on master between\nreleases.
\n", "modules": [ { "textRaw": "ERR_FS_WATCHER_ALREADY_STARTED", "name": "err_fs_watcher_already_started", "desc": "An attempt was made to start a watcher returned by fs.watch() that has\nalready been started.
An attempt was made to initiate operations on a watcher returned by\nfs.watch() that has not yet been started.
Occurs with multiple attempts to shutdown an HTTP/2 session.
\n", "type": "module", "displayName": "ERR_HTTP2_ALREADY_SHUTDOWN" }, { "textRaw": "ERR_HTTP2_ERROR", "name": "err_http2_error", "desc": "A non-specific HTTP/2 error has occurred.
\n", "type": "module", "displayName": "ERR_HTTP2_ERROR" }, { "textRaw": "ERR_INVALID_REPL_HISTORY", "name": "err_invalid_repl_history", "desc": "Used in the repl in case the old history file is used and an error occurred\nwhile trying to read and parse it.
Used when an ES6 module loader hook specifies format: 'dynamic' but does\nnot provide a dynamicInstantiate hook.
Used to prevent an abort if a string decoder was set on the Socket.
\nconst Socket = require('net').Socket;\nconst instance = new Socket();\n\ninstance.setEncoding('utf8');\nAn attempt has been made to create a string larger than the maximum allowed\nsize.
", "type": "module", "displayName": "ERR_STRING_TOO_LARGE" } ], "type": "module", "displayName": "Other error codes" } ], "type": "misc", "displayName": "Legacy Node.js Error Codes" } ], "classes": [ { "textRaw": "Class: Error", "type": "class", "name": "Error", "desc": "A generic JavaScript Error object that does not denote any specific\ncircumstance of why the error occurred. Error objects capture a \"stack trace\"\ndetailing the point in the code at which the Error was instantiated, and may\nprovide a text description of the error.
For crypto only, Error objects will include the OpenSSL error stack in a\nseparate property called opensslErrorStack if it is available when the error\nis thrown.
All errors generated by Node.js, including all System and JavaScript errors,\nwill either be instances of, or inherit from, the Error class.
Creates a .stack property on targetObject, which when accessed returns\na string representing the location in the code at which\nError.captureStackTrace() was called.
const myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack; // similar to `new Error().stack`\nThe first line of the trace will be prefixed with\n${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames\nabove constructorOpt, including constructorOpt, will be omitted from the\ngenerated stack trace.
The constructorOpt argument is useful for hiding implementation\ndetails of error generation from an end user. For instance:
function MyError() {\n Error.captureStackTrace(this, MyError);\n}\n\n// Without passing MyError to captureStackTrace, the MyError\n// frame would show up in the .stack property. By passing\n// the constructor, we omit that frame, and retain all frames below it.\nnew MyError().stack;\nThe Error.stackTraceLimit property specifies the number of stack frames\ncollected by a stack trace (whether generated by new Error().stack or\nError.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes\nwill 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\nnot capture any frames.
" }, { "textRaw": "`code` {string}", "type": "string", "name": "code", "desc": "The error.code property is a string label that identifies the kind of error.\nerror.code is the most stable way to identify an error. It will only change\nbetween major versions of Node.js. In contrast, error.message strings may\nchange between any versions of Node.js. See Node.js Error Codes for details\nabout specific codes.
The error.message property is the string description of the error as set by\ncalling new Error(message). The message passed to the constructor will also\nappear in the first line of the stack trace of the Error, however changing\nthis property after the Error object is created may not change the first\nline of the stack trace (for example, when error.stack is read before this\nproperty is changed).
const err = new Error('The message');\nconsole.error(err.message);\n// Prints: The message\nThe error.stack property is a string describing the point in the code at which\nthe Error was instantiated.
Error: Things keep happening!\n at /home/gbusey/file.js:525:2\n at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)\n at Actor.<anonymous> (/home/gbusey/actors.js:400:8)\n at increaseSynergy (/home/gbusey/actors.js:701:6)\nThe first line is formatted as <error class name>: <error message>, and\nis followed by a series of stack frames (each line beginning with \"at \").\nEach frame describes a call site within the code that lead to the error being\ngenerated. V8 attempts to display a name for each function (by variable name,\nfunction name, or object method name), but occasionally it will not be able to\nfind a suitable name. If V8 cannot determine a name for the function, only\nlocation information will be displayed for that frame. Otherwise, the\ndetermined function name will be displayed with location information appended\nin parentheses.
Frames are only generated for JavaScript functions. If, for example, execution\nsynchronously passes through a C++ addon function called cheetahify which\nitself calls a JavaScript function, the frame representing the cheetahify call\nwill not be present in the stack traces:
const cheetahify = require('./native-binding.node');\n\nfunction makeFaster() {\n // cheetahify *synchronously* calls speedy.\n cheetahify(function speedy() {\n throw new Error('oh no!');\n });\n}\n\nmakeFaster();\n// will throw:\n// /home/gbusey/file.js:6\n// throw new Error('oh no!');\n// ^\n// Error: oh no!\n// at speedy (/home/gbusey/file.js:6:11)\n// at makeFaster (/home/gbusey/file.js:5:3)\n// at Object.<anonymous> (/home/gbusey/file.js:10:1)\n// at Module._compile (module.js:456:26)\n// at Object.Module._extensions..js (module.js:474:10)\n// at Module.load (module.js:356:32)\n// at Function.Module._load (module.js:312:12)\n// at Function.Module.runMain (module.js:497:10)\n// at startup (node.js:119:16)\n// at node.js:906:3\nThe location information will be one of:
\nnative, if the frame represents a call internal to V8 (as in [].forEach).plain-filename.js:line:column, if the frame represents a call internal\nto Node.js./absolute/path/to/file.js:line:column, if the frame represents a call in\na user program, or its dependencies.The string representing the stack trace is lazily generated when the\nerror.stack property is accessed.
The number of frames captured by the stack trace is bounded by the smaller of\nError.stackTraceLimit or the number of available frames on the current event\nloop tick.
System-level errors are generated as augmented Error instances, which are\ndetailed here.
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
A subclass of Error that indicates the failure of an assertion. For details,\nsee Class: assert.AssertionError.
A subclass of Error that indicates that a provided argument was not within the\nset or range of acceptable values for a function; whether that is a numeric\nrange, or outside the set of options for a given function parameter.
require('net').connect(-1);\n// throws \"RangeError: \"port\" option should be >= 0 and < 65536: -1\"\nNode.js will generate and throw RangeError instances immediately as a form\nof argument validation.
A subclass of Error that indicates that an attempt is being made to access a\nvariable that is not defined. Such errors commonly indicate typos in code, or\nan otherwise broken program.
While client code may generate and propagate these errors, in practice, only V8\nwill do so.
\ndoesNotExist;\n// throws ReferenceError, doesNotExist is not a variable in this program.\nUnless an application is dynamically generating and running code,\nReferenceError instances should always be considered a bug in the code\nor its dependencies.
A subclass of Error that indicates that a program is not valid JavaScript.\nThese errors may only be generated and propagated as a result of code\nevaluation. Code evaluation may happen as a result of eval, Function,\nrequire, or vm. These errors are almost always indicative of a broken\nprogram.
try {\n require('vm').runInThisContext('binary ! isNotOk');\n} catch (err) {\n // err will be a SyntaxError\n}\nSyntaxError instances are unrecoverable in the context that created them –\nthey may only be caught by other contexts.
A subclass of Error that indicates that a provided argument is not an\nallowable type. For example, passing a function to a parameter which expects a\nstring would be considered a TypeError.
require('url').parse(() => { });\n// throws TypeError, since it expected a string\nNode.js will generate and throw TypeError instances immediately as a form\nof argument validation.