- assert - 断言
- Buffer - 缓冲器
- child_process - 子进程
- cluster - 集群
- console - 控制台
- crypto - 加密
- dgram - 数据报
- dns - 域名服务器
- Error - 异常
- events - 事件
- fs - 文件系统
- global - 全局变量
- http - HTTP
- https - HTTPS
- module - 模块
- net - 网络
- os - 操作系统
- path - 路径
- process - 进程
- querystring - 查询字符串
- readline - 逐行读取
- repl - 交互式解释器
- stream - 流
- string_decoder - 字符串解码器
- timer - 定时器
- tls - 安全传输层
- tty - 终端
- url - 网址
- util - 实用工具
- v8 - V8引擎
- vm - 虚拟机
- zlib - 压缩
Node.js v10.8.0 文档
目录
-
- Class: AssertionError
- RangeError 类
- ReferenceError 类
- SyntaxError 类
- TypeError 类
- 异常与错误
-
- ERR_AMBIGUOUS_ARGUMENT
- ERR_ARG_NOT_ITERABLE
- ERR_ASSERTION
- ERR_ASYNC_CALLBACK
- ERR_ASYNC_TYPE
- ERR_BUFFER_OUT_OF_BOUNDS
- ERR_BUFFER_TOO_LARGE
- ERR_CANNOT_TRANSFER_OBJECT
- ERR_CANNOT_WATCH_SIGINT
- ERR_CHILD_CLOSED_BEFORE_REPLY
- ERR_CHILD_PROCESS_IPC_REQUIRED
- ERR_CHILD_PROCESS_STDIO_MAXBUFFER
- ERR_CLOSED_MESSAGE_PORT
- ERR_CONSOLE_WRITABLE_STREAM
- ERR_CONSTRUCT_CALL_REQUIRED
- ERR_CPU_USAGE
- ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED
- ERR_CRYPTO_ECDH_INVALID_FORMAT
- ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY
- ERR_CRYPTO_ENGINE_UNKNOWN
- ERR_CRYPTO_FIPS_FORCED
- ERR_CRYPTO_FIPS_UNAVAILABLE
- ERR_CRYPTO_HASH_DIGEST_NO_UTF16
- ERR_CRYPTO_HASH_FINALIZED
- ERR_CRYPTO_HASH_UPDATE_FAILED
- ERR_CRYPTO_INVALID_DIGEST
- ERR_CRYPTO_INVALID_STATE
- ERR_CRYPTO_PBKDF2_ERROR
- ERR_CRYPTO_SCRYPT_INVALID_PARAMETER
- ERR_CRYPTO_SCRYPT_NOT_SUPPORTED
- ERR_CRYPTO_SIGN_KEY_REQUIRED
- ERR_CRYPTO_TIMING_SAFE_EQUAL_LENGTH
- ERR_DNS_SET_SERVERS_FAILED
- ERR_DOMAIN_CALLBACK_NOT_AVAILABLE
- ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE
- ERR_ENCODING_INVALID_ENCODED_DATA
- ERR_ENCODING_NOT_SUPPORTED
- ERR_FALSY_VALUE_REJECTION
- ERR_FS_FILE_TOO_LARGE
- ERR_FS_INVALID_SYMLINK_TYPE
- ERR_HTTP_HEADERS_SENT
- ERR_HTTP_INVALID_HEADER_VALUE
- ERR_HTTP_INVALID_STATUS_CODE
- ERR_HTTP_TRAILER_INVALID
- ERR_HTTP2_ALTSVC_INVALID_ORIGIN
- ERR_HTTP2_ALTSVC_LENGTH
- ERR_HTTP2_CONNECT_AUTHORITY
- ERR_HTTP2_CONNECT_PATH
- ERR_HTTP2_CONNECT_SCHEME
- ERR_HTTP2_ERROR
- ERR_HTTP2_GOAWAY_SESSION
- ERR_HTTP2_HEADERS_AFTER_RESPOND
- ERR_HTTP2_HEADERS_SENT
- ERR_HTTP2_HEADER_SINGLE_VALUE
- ERR_HTTP2_INFO_STATUS_NOT_ALLOWED
- ERR_HTTP2_INVALID_CONNECTION_HEADERS
- ERR_HTTP2_INVALID_HEADER_VALUE
- ERR_HTTP2_INVALID_INFO_STATUS
- ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH
- ERR_HTTP2_INVALID_PSEUDOHEADER
- ERR_HTTP2_INVALID_SESSION
- ERR_HTTP2_INVALID_SETTING_VALUE
- ERR_HTTP2_INVALID_STREAM
- ERR_HTTP2_MAX_PENDING_SETTINGS_ACK
- ERR_HTTP2_NO_SOCKET_MANIPULATION
- ERR_HTTP2_OUT_OF_STREAMS
- ERR_HTTP2_PAYLOAD_FORBIDDEN
- ERR_HTTP2_PING_CANCEL
- ERR_HTTP2_PING_LENGTH
- ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED
- ERR_HTTP2_PUSH_DISABLED
- ERR_HTTP2_SEND_FILE
- ERR_HTTP2_SEND_FILE_NOSEEK
- ERR_HTTP2_SESSION_ERROR
- ERR_HTTP2_SETTINGS_CANCEL
- ERR_HTTP2_SOCKET_BOUND
- ERR_HTTP2_STATUS_101
- ERR_HTTP2_STATUS_INVALID
- ERR_HTTP2_STREAM_CANCEL
- ERR_HTTP2_STREAM_ERROR
- ERR_HTTP2_STREAM_SELF_DEPENDENCY
- ERR_HTTP2_TRAILERS_ALREADY_SENT
- ERR_HTTP2_TRAILERS_NOT_READY
- ERR_HTTP2_UNSUPPORTED_PROTOCOL
- ERR_INDEX_OUT_OF_RANGE
- ERR_INSPECTOR_ALREADY_CONNECTED
- ERR_INSPECTOR_CLOSED
- ERR_INSPECTOR_NOT_AVAILABLE
- ERR_INSPECTOR_NOT_CONNECTED
- ERR_INVALID_ADDRESS_FAMILY
- ERR_INVALID_ARG_TYPE
- ERR_INVALID_ARG_VALUE
- ERR_INVALID_ARRAY_LENGTH
- ERR_INVALID_ASYNC_ID
- ERR_INVALID_BUFFER_SIZE
- ERR_INVALID_CALLBACK
- ERR_INVALID_CHAR
- ERR_INVALID_CURSOR_POS
- ERR_INVALID_DOMAIN_NAME
- ERR_INVALID_FD
- ERR_INVALID_FD_TYPE
- ERR_INVALID_FILE_URL_HOST
- ERR_INVALID_FILE_URL_PATH
- ERR_INVALID_HANDLE_TYPE
- ERR_INVALID_HTTP_TOKEN
- ERR_INVALID_IP_ADDRESS
- ERR_INVALID_OPT_VALUE
- ERR_INVALID_OPT_VALUE_ENCODING
- ERR_INVALID_PERFORMANCE_MARK
- ERR_INVALID_PROTOCOL
- ERR_INVALID_REPL_EVAL_CONFIG
- ERR_INVALID_RETURN_PROPERTY
- ERR_INVALID_RETURN_PROPERTY_VALUE
- ERR_INVALID_RETURN_VALUE
- ERR_INVALID_SYNC_FORK_INPUT
- ERR_INVALID_THIS
- ERR_INVALID_TRANSFER_OBJECT
- ERR_INVALID_TUPLE
- ERR_INVALID_URI
- ERR_INVALID_URL
- ERR_INVALID_URL_SCHEME
- ERR_IPC_CHANNEL_CLOSED
- ERR_IPC_DISCONNECTED
- ERR_IPC_ONE_PIPE
- ERR_IPC_SYNC_FORK
- ERR_MEMORY_ALLOCATION_FAILED
- ERR_METHOD_NOT_IMPLEMENTED
- ERR_MISSING_ARGS
- ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK
- ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST
- ERR_MISSING_MODULE
- ERR_MISSING_PLATFORM_FOR_WORKER
- ERR_MODULE_RESOLUTION_LEGACY
- ERR_MULTIPLE_CALLBACK
- ERR_NAPI_CONS_FUNCTION
- ERR_NAPI_INVALID_DATAVIEW_ARGS
- ERR_NAPI_INVALID_TYPEDARRAY_ALIGNMENT
- ERR_NAPI_INVALID_TYPEDARRAY_LENGTH
- ERR_NAPI_TSFN_CALL_JS
- ERR_NAPI_TSFN_GET_UNDEFINED
- ERR_NAPI_TSFN_START_IDLE_LOOP
- ERR_NAPI_TSFN_STOP_IDLE_LOOP
- ERR_NO_CRYPTO
- ERR_NO_ICU
- ERR_NO_LONGER_SUPPORTED
- ERR_OUT_OF_RANGE
- ERR_REQUIRE_ESM
- ERR_SCRIPT_EXECUTION_INTERRUPTED
- ERR_SERVER_ALREADY_LISTEN
- ERR_SERVER_NOT_RUNNING
- ERR_SOCKET_ALREADY_BOUND
- ERR_SOCKET_BAD_BUFFER_SIZE
- ERR_SOCKET_BAD_PORT
- ERR_SOCKET_BAD_TYPE
- ERR_SOCKET_BUFFER_SIZE
- ERR_SOCKET_CANNOT_SEND
- ERR_SOCKET_CLOSED
- ERR_SOCKET_DGRAM_NOT_RUNNING
- ERR_STDERR_CLOSE
- ERR_STDOUT_CLOSE
- ERR_STREAM_CANNOT_PIPE
- ERR_STREAM_DESTROYED
- ERR_STREAM_NULL_VALUES
- ERR_STREAM_PREMATURE_CLOSE
- ERR_STREAM_PUSH_AFTER_EOF
- ERR_STREAM_READ_NOT_IMPLEMENTED
- ERR_STREAM_UNSHIFT_AFTER_END_EVENT
- ERR_STREAM_WRAP
- ERR_STREAM_WRITE_AFTER_END
- ERR_STRING_TOO_LONG
- ERR_SYSTEM_ERROR
- ERR_TLS_CERT_ALTNAME_INVALID
- ERR_TLS_DH_PARAM_SIZE
- ERR_TLS_HANDSHAKE_TIMEOUT
- ERR_TLS_RENEGOTIATE
- ERR_TLS_RENEGOTIATION_DISABLED
- ERR_TLS_REQUIRED_SERVER_NAME
- ERR_TLS_SESSION_ATTACK
- ERR_TLS_SNI_FROM_SERVER
- ERR_TRACE_EVENTS_CATEGORY_REQUIRED
- ERR_TRACE_EVENTS_UNAVAILABLE
- ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER
- ERR_TRANSFORM_ALREADY_TRANSFORMING
- ERR_TRANSFORM_WITH_LENGTH_0
- ERR_TTY_INIT_FAILED
- ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET
- ERR_UNESCAPED_CHARACTERS
- ERR_UNHANDLED_ERROR
- ERR_UNKNOWN_BUILTIN_MODULE
- ERR_UNKNOWN_ENCODING
- ERR_UNKNOWN_FILE_EXTENSION
- ERR_UNKNOWN_MODULE_FORMAT
- ERR_UNKNOWN_SIGNAL
- ERR_UNKNOWN_STDIN_TYPE
- ERR_UNKNOWN_STREAM_TYPE
- ERR_V8BREAKITERATOR
- ERR_VALID_PERFORMANCE_ENTRY_TYPE
- ERR_VALUE_OUT_OF_RANGE
- ERR_VM_MODULE_ALREADY_LINKED
- ERR_VM_MODULE_DIFFERENT_CONTEXT
- ERR_VM_MODULE_LINKING_ERRORED
- ERR_VM_MODULE_NOT_LINKED
- ERR_VM_MODULE_NOT_MODULE
- ERR_VM_MODULE_STATUS
- ERR_WORKER_PATH
- ERR_WORKER_UNSERIALIZABLE_ERROR
- ERR_WORKER_UNSUPPORTED_EXTENSION
- ERR_ZLIB_INITIALIZATION_FAILED
- MODULE_NOT_FOUND
Error (错误)#
Node.js 中运行的应用程序一般会遇到以下四类错误:
-
标准的 JavaScript 错误:
- <EvalError> : 当调用
eval()
失败时抛出。 - <SyntaxError> : 当 JavaScript 语法错误时抛出。
- <RangeError> : 当值不在预期范围内时抛出。
- <ReferenceError> : 当使用未定义的变量时抛出。
- <TypeError> : 当传入错误类型的参数时抛出。
- <URIError> : 当全局的 URI 处理函数被误用时抛出。
- <EvalError> : 当调用
- 由底层操作系触发的系统错误,例如试图打开一个不存在的文件、试图通过一个已关闭的 socket 发送数据等。
- 由应用程序代码触发的用户自定义的错误。
- 断言错误是错误的一个特殊类别,每当 Node.js 检测到一个不应该发生的异常逻辑时触发。
这类错误通常由
assert
模块引起。
所有由 Node.js 引起的 JavaScript 错误与系统错误都继承自或实例化自标准的 JavaScript <Error> 类,且保证至少提供类中的属性。
错误的冒泡和捕获#
Node.js 支持几种当应用程序运行时发生的错误的冒泡和处理的机制。 如何报告和处理这些错误完全取决于错误的类型和被调用的 API 的风格。
所有 JavaScript 错误都会被作为异常处理,异常会立即产生并使用标准的 JavaScript throw
机制抛出一个错误。
这些都是使用 JavaScript 语言提供的 try / catch
语句处理的。
// 抛出一个 ReferenceError,因为 z 为 undefined
try {
const m = 1;
const n = m + z;
} catch (err) {
// 在这里处理错误。
}
JavaScript 的 throw
机制的任何使用都会引起异常,异常必须使用 try / catch
处理,否则 Node.js 进程会立即退出。
除了少数例外,同步的 API(任何不接受 callback
函数的阻塞方法,例如 fs.readFileSync
)会使用 throw
报告错误。
异步的 API 中发生的错误可能会以多种方式进行报告:
- 大多数的异步方法都接受一个
callback
函数,该函数会接受一个Error
对象传入作为第一个参数。 如果第一个参数不是null
而是一个Error
实例,则说明发生了错误,应该进行处理。
const fs = require('fs');
fs.readFile('一个不存在的文件', (err, data) => {
if (err) {
console.error('读取文件出错!', err);
return;
}
// 否则处理数据
});
-
当一个异步方法被一个
EventEmitter
对象调用时,错误会被分发到对象的'error'
事件上。const net = require('net'); const connection = net.connect('localhost'); // 添加一个 'error' 事件句柄到一个流: connection.on('error', (err) => { // 如果连接被服务器重置,或无法连接,或发生任何错误,则错误会被发送到这里。 console.error(err); }); connection.pipe(process.stdout);
-
Node.js API 中有一小部分普通的异步方法仍可能使用
throw
机制抛出异常,且必须使用try / catch
处理。 这些方法并没有一个完整的列表;请参阅各个方法的文档以确定所需的合适的错误处理机制。
'error'
事件机制的使用常见于基于流和基于事件触发器的 API,它们本身就代表了一系列的异步操作(相对于要么成功要么失败的单一操作)。
对于所有的 EventEmitter
对象,如果没有提供一个 'error'
事件句柄,则错误会被抛出,并造成 Node.js 进程报告一个未处理的异常且随即崩溃,除非:
适当地使用 domain
模块或已经注册了一个 [process.on('uncaughtException')
] 事件的句柄。
const EventEmitter = require('events');
const ee = new EventEmitter();
setImmediate(() => {
// 这会使进程崩溃,因为还为添加 'error' 事件句柄。
ee.emit('error', new Error('这会崩溃'));
});
这种方式产生的错误无法使用 try / catch
截获,因为它们是在调用的代码已经退出后抛出的。
开发者必须查阅各个方法的文档以明确在错误发生时这些方法是如何冒泡的。
Error-first callbacks#
大多数 Node.js 核心 API 所提供的异步方法都遵从错误信息优先的回调模式惯例,这种模式有时也称为 Node.js 式回调。在这种模式中,一个回调函数首先被作为参数传给异步方法。当该方法完成操作或产生错误时,它会调用回调函数,并将可能存在的 Error
对象作为第一个参数传给回调函数。如果没有错误产生,那么第一个参数为 null
。
const fs = require('fs');
function errorFirstCallback(err, data) {
if (err) {
console.error('There was an error', err);
return;
}
console.log(data);
}
fs.readFile('/some/file/that/does-not-exist', errorFirstCallback);
fs.readFile('/some/file/that/does-exist', errorFirstCallback);
JavaScript的 try / catch
机制不能用来截获异步方法产生的错误。新手的常见错误之一是试图在错误优先回调函数中使用 throw
:
// 这不可行:
const fs = require('fs');
try {
fs.readFile('/some/file/that/does-not-exist', (err, data) => {
// mistaken assumption: throwing here...
if (err) {
throw err;
}
});
} catch (err) {
// 这里不会截获回调函数中的throw
console.error(err);
}
这样做不可行,因为传递给 fs.readFile()
的回调函数是异步调用的。当回调函数被调用时,程序早已退出其周围的代码(包括 try { } catch (err) { }
部分)。在回调函数内抛出异常在大多数时候会使 Node.js 进程崩溃。但如果启用了 domains ,或者有与 process.on('uncaughtException')
相关联的异常处理器,就可以截获这种错误。
Error 类#
一个通用的 JavaScript Error
对象,它不表示错误发生的具体情况。
Error
对象会捕捉一个“堆栈跟踪”,详细说明被实例化的 Error
对象在代码中的位置,并可能提供错误的文字描述。
只对于加密,如果在抛出错误时可以使用 Error
对象,则会将OpenSSL错误堆栈放入到名为 opensslErrorStack
的单独属性中。
所有由 Node.js 产生的错误,包括所有系统的和 JavaScript 的错误都实例化自或继承自 Error
类。
new Error(message)#
message
<string>
新建一个 Error
实例,并设置 error.message
属性以提供文本信息。
如果 message
传的是一个对象,则会调用 message.toString()
生成文本信息。
error.stack
属性表示被调用的 new Error()
在代码中的位置。
堆栈跟踪是基于 V8 的堆栈跟踪 API 的。
堆栈跟踪只会取(a)异步代码执行的开头或(b)Error.stackTraceLimit
属性给出的栈帧中的最小项。
Error.captureStackTrace(targetObject[, constructorOpt])#
targetObject
<Object>constructorOpt
<Function>
在 targetObject
上创建一个 .stack
属性,当访问时返回一个表示代码中调用 Error.captureStackTrace()
的位置的字符串。
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // 类似 `new Error().stack`
${myObject.name}: ${myObject.message}
会作为该堆栈跟踪的第一行。
可选的 constructorOpt
参数接受一个函数。
如果提供了,则 constructorOpt
之上包括自身在内的全部栈帧都会被生成的堆栈跟踪省略。
constructorOpt
参数用在向最终用户隐藏错误生成的具体细节时非常有用。例如:
function MyError() {
Error.captureStackTrace(this, MyError);
}
// 没传入 MyError 到 captureStackTrace,MyError 帧会显示在 .stack 属性。
// 通过传入构造函数,可以省略该帧,且保留其下面的所有帧。
new MyError().stack;
Error.stackTraceLimit#
Error.stackTraceLimit
属性指定了堆栈跟踪收集的栈帧数量(无论是 new Error().stack
或 Error.captureStackTrace(obj)
产生的)。
默认值为 10
,但可设为任何有效的 JavaScript 数值。
值改变后的变化会影响所有捕获到的堆栈跟踪。
如果设为一个非数值或负数,则堆栈跟踪不会捕捉任何栈帧。
error.code#
error.code
属性是标识错误类别的字符标签。详见 Node.js Error Codes 关于特定的错误码
error.message#
error.message
属性是错误的字符串描述,通过调用 new Error(message)
设置。
传给构造函数的 message
也会出现在 Error
的堆栈跟踪的第一行。
但是,Error
对象创建后改变这个属性可能不会改变堆栈跟踪的第一行(比如当 error.stack
在该属性被改变之前被读取)。
const err = new Error('错误信息');
console.error(err.message);
// 打印: 错误信息
error.stack#
error.stack
属性是一个字符串,描述代码中 Error
被实例化的位置。
例子:
Error: Things keep happening!
at /home/gbusey/file.js:525:2
at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
at Actor.<anonymous> (/home/gbusey/actors.js:400:8)
at increaseSynergy (/home/gbusey/actors.js:701:6)
第一行会被格式化为 <error class name>: <error message>
,且带上一系列栈帧(每一行都以 "at " 开头)。
每一帧描述了一个代码中导致错误生成的调用点。
V8 引擎会试图显示每个函数的名称(变量名、函数名、或对象的方法名),但偶尔也可能找不到一个合适的名称。
如果 V8 引擎没法确定一个函数的名称,则只显示帧的位置信息。
否则,在位置信息的旁边会显示明确的函数名。
帧只由 JavaScript 函数产生。
例如,同步地执行一个名为 cheetahify
的 C++ 插件,且插件自身调用一个 JavaScript 函数,代表 cheetahify
回调的栈帧不会出现在堆栈跟踪里:
const cheetahify = require('./native-binding.node');
function makeFaster() {
// cheetahify 同步地调用 speedy.
cheetahify(function speedy() {
throw new Error('oh no!');
});
}
makeFaster();
// will throw:
// /home/gbusey/file.js:6
// throw new Error('oh no!');
// ^
// Error: oh no!
// at speedy (/home/gbusey/file.js:6:11)
// at makeFaster (/home/gbusey/file.js:5:3)
// at Object.<anonymous> (/home/gbusey/file.js:10:1)
// at Module._compile (module.js:456:26)
// at Object.Module._extensions..js (module.js:474:10)
// at Module.load (module.js:356:32)
// at Function.Module._load (module.js:312:12)
// at Function.Module.runMain (module.js:497:10)
// at startup (node.js:119:16)
// at node.js:906:3
位置信息会是其中之一:
native
,帧表示一个 V8 引擎内部的调用(比如,[].forEach
)。plain-filename.js:line:column
,帧表示一个 Node.js 内部的调用。/absolute/path/to/file.js:line:column
,帧表示一个用户程序或其依赖的调用。
代表堆栈跟踪的字符串是在 error.stack
属性被访问时才生成的。
堆栈跟踪捕获的帧的数量是由 Error.stackTraceLimit
或当前事件循环中可用的帧数量的最小值界定的。
系统级的错误是由扩展的 Error
实例产生的,详见系统错误。
Class: AssertionError#
Error
的子类,表示断言失败。 这种错误通常表示实际值和预期值不相等。
比如:
assert.strictEqual(1, 2);
// AssertionError [ERR_ASSERTION]: 1 === 2
RangeError 类#
Error
的一个子类,表明一个函数的一个给定的参数的值不在可接受的集合或范围内;
无论是一个数字范围还是给定函数参数的选项的集合。
例子:
require('net').connect(-1);
// 抛出 "RangeError: "port" option should be >= 0 and < 65536: -1"
Node.js 会生成并以参数校验的形式立即抛出 RangeError
实例。
ReferenceError 类#
Error
的一个子类,表明试图访问一个未定义的变量。
这些错误通常表明代码有拼写错误或程序已损坏。
虽然客户端代码可能产生和传播这些错误,但在实践中,只有 V8 引擎会这么做。
doesNotExist;
// 抛出 ReferenceError,在这个程序中 doesNotExist 不是一个变量。
除非应用程序是动态生成并运行的代码,否则 ReferenceError
实例应该始终被视为代码中或其依赖中的错误。
SyntaxError 类#
Error
的一个子类,表明程序不是有效的 JavaScript 代码。
这些错误是代码执行的结果产生和传播的。
代码执行可能产生自 eval
、Function
、require
或 vm。
这些错误几乎都表明程序已损坏。
try {
require('vm').runInThisContext('binary ! isNotOk');
} catch (err) {
// err 是一个 SyntaxError
}
SyntaxError
实例在创建它们的上下文中是不可恢复的。
它们只可被其他上下文捕获。
TypeError 类#
Error
的一个子类,表明提供的参数不是一个被允许的类型。
例如,将一个函数传给一个期望字符串的参数会被视为一个 TypeError
。
require('url').parse(() => { });
// 抛出 TypeError,因为它期望的是一个字符串
Node.js 会生成并以参数校验的形式立即抛出 TypeError
实例。
异常与错误#
JavaScript 异常是一个作为一个无效操作的结果或作为一个 throw
声明的目标所抛出的值。
虽然它不要求这些值是 Error
的实例或继承自 Error
的类的实例,但所有通过 Node.js 或 JavaScript 运行时抛出的异常都是 Error
实例。
有些异常在 JavaScript 层是无法恢复的。
这些异常总会引起 Node.js 进程的崩溃。
例如 assert()
检测或在 C++ 层调用的 abort()
。
系统错误#
系统错误是当程序运行环境中发生异常时产生的。 特别是,当应用程序违反了操作系统的限制时发生的操作错误,例如试图读取一个不存在的文件或用户没有足够的权限。
系统错误通常产生于系统调用层级。
在大多数 Unix 系统上,可通过运行 man 2 intro
、man 3 errno
、或在线文档获取错误代码的详细清单和含义。
系统错误是由扩展的 Error
对象加上附加属性表现的。
Class: SystemError#
error.info#
SystemError
实例可能附有一个 info
属性,其值是一个对象,记录了关于错误情况的更多细节。
SystemError
实例提供以下属性:
code
<string> 错误代码字符串errno
<number> 系统提供的错误代号message
<string> 系统提供的常人能理解的错误描述syscall
<string> 触发了错误的系统调用的名称path
<Buffer> 当汇报文件系统的错误时path
包含与之有关的文件的路径dest
<Buffer> 当汇报文件系统的错误时dest
包含与之有关的文件目的地的路径(如果存在)
error.code#
error.code
属性是一个表示错误码的字符串,总是 E
带上一串大写字母。
error.errno#
error.errno
属性是一个数值或字符串。
如果返回一个数值,则数值是一个负数,对应 libuv 错误处理
中定义的错误码。
详见 uv-errno.h 头文件(Node.js 源代码中的 deps/uv/include/uv-errno.h
)。
如果返回一个字符串,则同 error.code
。
error.syscall#
error.syscall
属性是一个字符串,描述失败的 系统调用。
error.path#
错误出现时 (比如 在 fs
或 child_process
), error.path
属性是一个字符串,包含了相关不可用路径名。
error.address#
错误出现时 (比如 在 net
或 dgram
), error.address
属性是对链接失败的地址的描述。
error.port#
错误出现时 (比如 在 net
或 dgram
), error.port
是一个链接端口不可用的端口值
常见的系统错误#
以下列表是不完整的,但列举了编写 Node.js 程序时会遇到的一些常见的系统错误。 详细的列表可从 ERRNO 文档找到。
-
EACCES
(拒绝访问): 试图以被一个文件的访问权限禁止的方式访问一个文件。 -
EADDRINUSE
(地址已被使用): 试图绑定一个服务器(net
、http
或https
)到本地地址,但因另一个本地系统的服务器已占用了该地址而导致失败。 -
ECONNREFUSED
(连接被拒绝): 无法连接,因为目标机器积极拒绝。 这通常是因为试图连接到外部主机上的废弃的服务。 -
ECONNRESET
(连接被重置): 一个连接被强行关闭。 这通常是因为连接到远程 socket 超时或重启。 常发生于http
和net
模块。 -
EEXIST
(文件已存在): 一个操作的目标文件已存在,而要求目标不存在。 -
EISDIR
(是一个目录): 一个操作要求一个文件,但给定的路径是一个目录。 -
EMFILE
(系统打开了太多文件): 已达到系统文件描述符允许的最大数量,且描述符的请求不能被满足直到至少关闭其中一个。 当一次并行打开多个文件时会发生这个错误,尤其是在进程的文件描述限制数量较低的操作系统(如 macOS)。 要解决这个限制,可在运行 Node.js 进程的同一 shell 中运行ulimit -n 2048
。 -
ENOENT
(无此文件或目录): 通常是由fs
操作引起的,表明指定的路径不存在,即给定的路径找不到文件或目录。 -
ENOTDIR
(不是一个目录): 给定的路径虽然存在,但不是一个目录。 通常是由fs.readdir
引起的。 -
ENOTEMPTY
(目录非空): 一个操作的目标是一个非空的目录,而要求的是一个空目录。 通常是由fs.unlink
引起的。 -
EPERM
(操作不被允许): 试图执行一个需要更高权限的操作。 -
EPIPE
(管道损坏): 写入一个管道、socket 或 FIFO 时没有进程读取数据。 常见于net
和http
层,表明远端要写入的流已被关闭。 -
ETIMEDOUT
(操作超时): 一个连接或发送的请求失败,因为连接方在一段时间后没有做出合适的响应。 常见于http
或net
。 往往标志着socket.end()
没有被正确地调用。
Node.js Error Codes#
ERR_AMBIGUOUS_ARGUMENT##
This is triggered by the assert
module in case e.g.,
assert.throws(fn, message)
is used in a way that the message is the thrown
error message. This is ambiguous because the message is not verifying the error
message and will only be thrown in case no error is thrown.
ERR_ARG_NOT_ITERABLE##
需要可遍历的参数(也就是可使用 for...of
遍历的值)。
ERR_ASSERTION##
A special type of error that can be triggered whenever Node.js detects an
exceptional logic violation that should never occur. These are raised typically
by the assert
module.
ERR_ASYNC_CALLBACK##
试图注册不是 AsyncHooks
回调的函数。
ERR_ASYNC_TYPE##
异步资源的类型不合法。 如果使用公共嵌入的 API,则用户可以定义自己的类型。
ERR_BUFFER_OUT_OF_BOUNDS##
An operation outside the bounds of a Buffer
was attempted.
ERR_BUFFER_TOO_LARGE##
An attempt has been made to create a Buffer
larger than the maximum allowed
size.
ERR_CANNOT_TRANSFER_OBJECT##
The value passed to postMessage()
contained an object that is not supported
for transferring.
ERR_CANNOT_WATCH_SIGINT##
Node.js was unable to watch for the SIGINT
signal.
ERR_CHILD_CLOSED_BEFORE_REPLY##
A child process was closed before the parent received a reply.
ERR_CHILD_PROCESS_IPC_REQUIRED##
Used when a child process is being forked without specifying an IPC channel.
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.
ERR_CLOSED_MESSAGE_PORT##
There was an attempt to use a MessagePort
instance in a closed
state, usually after .close()
has been called.
ERR_CONSOLE_WRITABLE_STREAM##
Console
was instantiated without stdout
stream, or Console
has a
non-writable stdout
or stderr
stream.
ERR_CONSTRUCT_CALL_REQUIRED##
A constructor for a class was called without new
.
ERR_CPU_USAGE##
The native call from process.cpuUsage
could not be processed.
ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED##
A client certificate engine was requested that is not supported by the version of OpenSSL being used.
ERR_CRYPTO_ECDH_INVALID_FORMAT##
An invalid value for the format
argument was passed to the crypto.ECDH()
class getPublicKey()
method.
ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY##
An invalid value for the key
argument has been passed to the
crypto.ECDH()
class computeSecret()
method. It means that the public
key lies outside of the elliptic curve.
ERR_CRYPTO_ENGINE_UNKNOWN##
An invalid crypto engine identifier was passed to
require('crypto').setEngine()
.
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.
ERR_CRYPTO_FIPS_UNAVAILABLE##
An attempt was made to enable or disable FIPS mode, but FIPS mode was not available.
ERR_CRYPTO_HASH_DIGEST_NO_UTF16##
The UTF-16 encoding was used with hash.digest()
. While the
hash.digest()
method does allow an encoding
argument to be passed in,
causing the method to return a string rather than a Buffer
, the UTF-16
encoding (e.g. ucs
or utf16le
) is not supported.
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.
ERR_CRYPTO_HASH_UPDATE_FAILED##
hash.update()
failed for any reason. This should rarely, if ever, happen.
ERR_CRYPTO_INVALID_DIGEST##
An invalid crypto digest algorithm was specified.
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()
.
ERR_CRYPTO_PBKDF2_ERROR##
The PBKDF2 algorithm failed for unspecified reasons. OpenSSL does not provide more details and therefore neither does Node.js.
ERR_CRYPTO_SCRYPT_INVALID_PARAMETER##
One or more crypto.scrypt()
or crypto.scryptSync()
parameters are
outside their legal range.
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.
ERR_CRYPTO_SIGN_KEY_REQUIRED##
A signing key
was not provided to the sign.sign()
method.
ERR_CRYPTO_TIMING_SAFE_EQUAL_LENGTH##
crypto.timingSafeEqual()
was called with Buffer
, TypedArray
, or
DataView
arguments of different lengths.
ERR_DNS_SET_SERVERS_FAILED##
c-ares
failed to set the DNS server.
ERR_DOMAIN_CALLBACK_NOT_AVAILABLE##
The domain
module was not usable since it could not establish the required
error handling hooks, because
process.setUncaughtExceptionCaptureCallback()
had been called at an
earlier point in time.
ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE##
process.setUncaughtExceptionCaptureCallback()
could not be called
because 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
domain
module had been loaded.
ERR_ENCODING_INVALID_ENCODED_DATA##
提供给 util.TextDecoder()
API 的数据不符合指定的编码。
ERR_ENCODING_NOT_SUPPORTED##
提供给 util.TextDecoder()
API 的字符编码不是WHATWG支持的字符编码。
ERR_FALSY_VALUE_REJECTION##
A Promise
that was callbackified via util.callbackify()
was rejected with a
falsy value.
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
.
ERR_FS_INVALID_SYMLINK_TYPE##
An invalid symlink type was passed to the fs.symlink()
or
fs.symlinkSync()
methods.
ERR_HTTP_HEADERS_SENT##
当消息头已发送后,还试图添加消息头。
ERR_HTTP_INVALID_HEADER_VALUE##
An invalid HTTP header value was specified.
ERR_HTTP_INVALID_STATUS_CODE##
状态码超出正常范围(100-999)。
ERR_HTTP_TRAILER_INVALID##
The Trailer
header was set even though the transfer encoding does not support
that.
ERR_HTTP2_ALTSVC_INVALID_ORIGIN##
HTTP/2 ALTSVC frames require a valid origin.
ERR_HTTP2_ALTSVC_LENGTH##
HTTP/2 ALTSVC frames are limited to a maximum of 16,382 payload bytes.
ERR_HTTP2_CONNECT_AUTHORITY##
For HTTP/2 requests using the CONNECT
method, the :authority
pseudo-header
is required.
ERR_HTTP2_CONNECT_PATH##
通过CONNECT
方法发送的HTTP/2请求时,:path
伪header 被禁用
ERR_HTTP2_CONNECT_SCHEME##
通过CONNECT
方法发送HTTP/2请求时,:scheme
伪header 被禁用。
ERR_HTTP2_ERROR##
A non-specific HTTP/2 error has occurred.
ERR_HTTP2_GOAWAY_SESSION##
New HTTP/2 Streams may not be opened after the Http2Session
has received a
GOAWAY
frame from the connected peer.
ERR_HTTP2_HEADERS_AFTER_RESPOND##
An additional headers was specified after an HTTP/2 response was initiated.
ERR_HTTP2_HEADERS_SENT##
An attempt was made to send multiple response headers.
ERR_HTTP2_HEADER_SINGLE_VALUE##
为只需一个值的 HTTP/2 消息头提供了多个值。
ERR_HTTP2_INFO_STATUS_NOT_ALLOWED##
Informational HTTP status codes (1xx
) may not be set as the response status
code on HTTP/2 responses.
ERR_HTTP2_INVALID_CONNECTION_HEADERS##
HTTP/1 connection specific headers are forbidden to be used in HTTP/2 requests and responses.
ERR_HTTP2_INVALID_HEADER_VALUE##
An invalid HTTP/2 header value was specified.
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).
ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH##
Input Buffer
and Uint8Array
instances passed to the
http2.getUnpackedSettings()
API must have a length that is a multiple of
six.
ERR_HTTP2_INVALID_PSEUDOHEADER##
Only valid HTTP/2 pseudoheaders (:status
, :path
, :authority
, :scheme
,
and :method
) may be used.
ERR_HTTP2_INVALID_SESSION##
An action was performed on an Http2Session
object that had already been
destroyed.
ERR_HTTP2_INVALID_SETTING_VALUE##
An invalid value has been specified for an HTTP/2 setting.
ERR_HTTP2_INVALID_STREAM##
An operation was performed on a stream that had already been destroyed.
ERR_HTTP2_MAX_PENDING_SETTINGS_ACK##
Whenever an HTTP/2 SETTINGS
frame is sent to a connected peer, the peer is
required to send an acknowledgment that it has received and applied the new
SETTINGS
. By default, a maximum number of unacknowledged SETTINGS
frames may
be sent at any given time. This error code is used when that limit has been
reached.
ERR_HTTP2_NO_SOCKET_MANIPULATION##
An attempt was made to directly manipulate (read, write, pause, resume, etc.) a
socket attached to an Http2Session
.
ERR_HTTP2_OUT_OF_STREAMS##
The number of streams created on a single HTTP/2 session reached the maximum limit.
ERR_HTTP2_PAYLOAD_FORBIDDEN##
A message payload was specified for an HTTP response code for which a payload is forbidden.
ERR_HTTP2_PING_CANCEL##
An HTTP/2 ping was canceled.
ERR_HTTP2_PING_LENGTH##
HTTP/2 ping payloads must be exactly 8 bytes in length.
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.
ERR_HTTP2_PUSH_DISABLED##
An attempt was made to create a push stream, which had been disabled by the client.
ERR_HTTP2_SEND_FILE##
An attempt was made to use the Http2Stream.prototype.responseWithFile()
API to
send a directory.
ERR_HTTP2_SEND_FILE_NOSEEK##
An attempt was made to use the Http2Stream.prototype.responseWithFile()
API to
send something other than a regular file, but offset
or length
options were
provided.
ERR_HTTP2_SESSION_ERROR##
The Http2Session
closed with a non-zero error code.
ERR_HTTP2_SETTINGS_CANCEL##
The Http2Session
settings canceled.
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.
ERR_HTTP2_STATUS_101##
Use of the 101
Informational status code is forbidden in HTTP/2.
ERR_HTTP2_STATUS_INVALID##
An invalid HTTP status code has been specified. Status codes must be an integer
between 100
and 599
(inclusive).
ERR_HTTP2_STREAM_CANCEL##
An Http2Stream
was destroyed before any data was transmitted to the connected
peer.
ERR_HTTP2_STREAM_ERROR##
A non-zero error code was been specified in an RST_STREAM
frame.
ERR_HTTP2_STREAM_SELF_DEPENDENCY##
When setting the priority for an HTTP/2 stream, the stream may be marked as a dependency for a parent stream. This error code is used when an attempt is made to mark a stream and dependent of itself.
ERR_HTTP2_TRAILERS_ALREADY_SENT##
Trailing headers have already been sent on the Http2Stream
.
ERR_HTTP2_TRAILERS_NOT_READY##
The http2stream.sendTrailers()
method cannot be called until after the
'wantTrailers'
event is emitted on an Http2Stream
object. The
'wantTrailers'
event will only be emitted if the waitForTrailers
option
is set for the Http2Stream
.
ERR_HTTP2_UNSUPPORTED_PROTOCOL##
http2.connect()
was passed a URL that uses any protocol other than http:
or
https:
.
ERR_INDEX_OUT_OF_RANGE##
A given index was out of the accepted range (e.g. negative offsets).
ERR_INSPECTOR_ALREADY_CONNECTED##
While using the inspector
module, an attempt was made to connect when the
inspector was already connected.
ERR_INSPECTOR_CLOSED##
While using the inspector
module, an attempt was made to use the inspector
after the session had already closed.
ERR_INSPECTOR_NOT_AVAILABLE##
The inspector
module is not available for use.
ERR_INSPECTOR_NOT_CONNECTED##
While using the inspector
module, an attempt was made to use the inspector
before it was connected.
ERR_INVALID_ADDRESS_FAMILY##
The provided address family is not understood by the Node.js API.
ERR_INVALID_ARG_TYPE##
An argument of the wrong type was passed to a Node.js API.
ERR_INVALID_ARG_VALUE##
An invalid or unsupported value was passed for a given argument.
ERR_INVALID_ARRAY_LENGTH##
An array was not of the expected length or in a valid range.
ERR_INVALID_ASYNC_ID##
An invalid asyncId
or triggerAsyncId
was passed using AsyncHooks
. An id
less than -1 should never happen.
ERR_INVALID_BUFFER_SIZE##
A swap was performed on a Buffer
but its size was not compatible with the
operation.
ERR_INVALID_CALLBACK##
A callback function was required but was not been provided to a Node.js API.
ERR_INVALID_CHAR##
Invalid characters were detected in headers.
ERR_INVALID_CURSOR_POS##
A cursor on a given stream cannot be moved to a specified row without a specified column.
ERR_INVALID_DOMAIN_NAME##
hostname
can not be parsed from a provided URL.
ERR_INVALID_FD##
A file descriptor ('fd') was not valid (e.g. it was a negative value).
ERR_INVALID_FD_TYPE##
A file descriptor ('fd') type was not valid.
ERR_INVALID_FILE_URL_HOST##
A Node.js API that consumes file:
URLs (such as certain functions in the
fs
module) encountered a file URL with an incompatible host. This
situation can only occur on Unix-like systems where only localhost
or an empty
host is supported.
ERR_INVALID_FILE_URL_PATH##
A Node.js API that consumes file:
URLs (such as certain functions in the
fs
module) encountered a file URL with an incompatible path. The exact
semantics for determining whether a path can be used is platform-dependent.
ERR_INVALID_HANDLE_TYPE##
An attempt was made to send an unsupported "handle" over an IPC communication
channel to a child process. See subprocess.send()
and process.send()
for
more information.
ERR_INVALID_HTTP_TOKEN##
An invalid HTTP token was supplied.
ERR_INVALID_IP_ADDRESS##
An IP address is not valid.
ERR_INVALID_OPT_VALUE##
An invalid or unexpected value was passed in an options object.
ERR_INVALID_OPT_VALUE_ENCODING##
An invalid or unknown file encoding was passed.
ERR_INVALID_PERFORMANCE_MARK##
While using the Performance Timing API (perf_hooks
), a performance mark is
invalid.
ERR_INVALID_PROTOCOL##
An invalid options.protocol
was passed.
ERR_INVALID_REPL_EVAL_CONFIG##
Both breakEvalOnSigint
and eval
options were set in the REPL config, which
is not supported.
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.
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.
ERR_INVALID_RETURN_VALUE##
Thrown in case a function option does not return an expected value type on execution. For example when a function is expected to return a promise.
ERR_INVALID_SYNC_FORK_INPUT##
A Buffer
, Uint8Array
or string
was provided as stdio input to a
synchronous fork. See the documentation for the child_process
module
for more information.
ERR_INVALID_THIS##
A Node.js API function was called with an incompatible this
value.
Example:
const urlSearchParams = new URLSearchParams('foo=bar&baz=new');
const buf = Buffer.alloc(1);
urlSearchParams.has.call(buf, 'foo');
// Throws a TypeError with code 'ERR_INVALID_THIS'
ERR_INVALID_TRANSFER_OBJECT##
An invalid transfer object was passed to postMessage()
.
ERR_INVALID_TUPLE##
An element in the iterable
provided to the WHATWG
URLSearchParams
constructor did not
represent a [name, value]
tuple – that is, if an element is not iterable, or
does not consist of exactly two elements.
ERR_INVALID_URI##
An invalid URI was passed.
ERR_INVALID_URL##
An invalid URL was passed to the WHATWG
URL
constructor to be parsed. The thrown error object
typically has an additional property 'input'
that contains the URL that failed
to parse.
ERR_INVALID_URL_SCHEME##
An attempt was made to use a URL of an incompatible scheme (protocol) for a
specific purpose. It is only used in the WHATWG URL API support in the
fs
module (which only accepts URLs with 'file'
scheme), but may be used
in other Node.js APIs as well in the future.
ERR_IPC_CHANNEL_CLOSED##
An attempt was made to use an IPC communication channel that was already closed.
ERR_IPC_DISCONNECTED##
An attempt was made to disconnect an IPC communication channel that was already
disconnected. See the documentation for the child_process
module
for more information.
ERR_IPC_ONE_PIPE##
An attempt was made to create a child Node.js process using more than one IPC
communication channel. See the documentation for the child_process
module
for more information.
ERR_IPC_SYNC_FORK##
An attempt was made to open an IPC communication channel with a synchronously
forked Node.js process. See the documentation for the child_process
module
for more information.
ERR_MEMORY_ALLOCATION_FAILED##
An attempt was made to allocate memory (usually in the C++ layer) but it failed.
ERR_METHOD_NOT_IMPLEMENTED##
A method is required but not implemented.
ERR_MISSING_ARGS##
A required argument of a Node.js API was not passed. This is only used for
strict compliance with the API specification (which in some cases may accept
func(undefined)
but not func()
). In most native Node.js APIs,
func(undefined)
and func()
are treated identically, and the
ERR_INVALID_ARG_TYPE
error code may be used instead.
ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK##
An ES6 module loader hook specified format: 'dynamic'
but did not provide
a dynamicInstantiate
hook.
ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST##
A MessagePort
was found in the object passed to a postMessage()
call,
but not provided in the transferList
for that call.
ERR_MISSING_MODULE##
An ES6 module could not be resolved.
ERR_MISSING_PLATFORM_FOR_WORKER##
The V8 platform used by this instance of Node.js does not support creating Workers. This is caused by lack of embedder support for Workers. In particular, this error will not occur with standard builds of Node.js.
ERR_MODULE_RESOLUTION_LEGACY##
A failure occurred resolving imports in an ES6 module.
ERR_MULTIPLE_CALLBACK##
A callback was called more than once.
A callback is almost always meant to only be called once as the query 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.
ERR_NAPI_CONS_FUNCTION##
While using N-API
, a constructor passed was not a function.
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
.
ERR_NAPI_INVALID_TYPEDARRAY_ALIGNMENT##
While calling napi_create_typedarray()
, the provided offset
was not a
multiple of the element size.
ERR_NAPI_INVALID_TYPEDARRAY_LENGTH##
While calling napi_create_typedarray()
, (length * size_of_element) + byte_offset
was larger than the length of given buffer
.
ERR_NAPI_TSFN_CALL_JS##
An error occurred while invoking the JavaScript portion of the thread-safe function.
ERR_NAPI_TSFN_GET_UNDEFINED##
An error occurred while attempting to retrieve the JavaScript undefined
value.
ERR_NAPI_TSFN_START_IDLE_LOOP##
On the main thread, values are removed from the queue associated with the thread-safe function in an idle loop. This error indicates that an error has occurred when attempting to start the loop.
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.
ERR_NO_CRYPTO##
An attempt was made to use crypto features while Node.js was not compiled with OpenSSL crypto support.
ERR_NO_ICU##
An attempt was made to use features that require ICU, but Node.js was not compiled with ICU support.
ERR_NO_LONGER_SUPPORTED##
A Node.js API was called in an unsupported manner, such as
Buffer.write(string, encoding, offset[, length])
.
ERR_OUT_OF_RANGE##
A given value is out of the accepted range.
ERR_REQUIRE_ESM##
An attempt was made to require()
an ES6 module.
ERR_SCRIPT_EXECUTION_INTERRUPTED##
Script execution was interrupted by SIGINT
(For example, when Ctrl+C was
pressed).
ERR_SERVER_ALREADY_LISTEN##
The server.listen()
method was called while a net.Server
was already
listening. This applies to all instances of net.Server
, including HTTP, HTTPS,
and HTTP/2 Server
instances.
ERR_SERVER_NOT_RUNNING##
The server.close()
method was called when a net.Server
was not
running. This applies to all instances of net.Server
, including HTTP, HTTPS,
and HTTP/2 Server
instances.
ERR_SOCKET_ALREADY_BOUND##
An attempt was made to bind a socket that has already been bound.
ERR_SOCKET_BAD_BUFFER_SIZE##
An invalid (negative) size was passed for either the recvBufferSize
or
sendBufferSize
options in dgram.createSocket()
.
ERR_SOCKET_BAD_PORT##
An API function expecting a port > 0 and < 65536 received an invalid value.
ERR_SOCKET_BAD_TYPE##
An API function expecting a socket type (udp4
or udp6
) received an invalid
value.
ERR_SOCKET_BUFFER_SIZE##
While using dgram.createSocket()
, the size of the receive or send Buffer
could not be determined.
ERR_SOCKET_CANNOT_SEND##
Data could be sent on a socket.
ERR_SOCKET_CLOSED##
An attempt was made to operate on an already closed socket.
ERR_SOCKET_DGRAM_NOT_RUNNING##
A call was made and the UDP subsystem was not running.
ERR_STDERR_CLOSE##
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.
ERR_STDOUT_CLOSE##
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.
ERR_STREAM_CANNOT_PIPE##
An attempt was made to call stream.pipe()
on a Writable
stream.
ERR_STREAM_DESTROYED##
A stream method was called that cannot complete because the stream was
destroyed using stream.destroy()
.
ERR_STREAM_NULL_VALUES##
An attempt was made to call stream.write()
with a null
chunk.
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.
ERR_STREAM_PUSH_AFTER_EOF##
An attempt was made to call stream.push()
after a null
(EOF) had been
pushed to the stream.
ERR_STREAM_READ_NOT_IMPLEMENTED##
An attempt was made to use a readable stream that did not implement
readable._read()
.
ERR_STREAM_UNSHIFT_AFTER_END_EVENT##
An attempt was made to call stream.unshift()
after the 'end'
event was
emitted.
ERR_STREAM_WRAP##
Prevents an abort if a string decoder was set on the Socket or if the decoder
is in objectMode
.
Example
const Socket = require('net').Socket;
const instance = new Socket();
instance.setEncoding('utf8');
ERR_STREAM_WRITE_AFTER_END##
An attempt was made to call stream.write()
after stream.end()
has been
called.
ERR_STRING_TOO_LONG##
An attempt has been made to create a string longer than the maximum allowed length.
ERR_SYSTEM_ERROR##
An unspecified or non-specific system error has occurred within the Node.js
process. The error object will have an err.info
object property with
additional details.
ERR_TLS_CERT_ALTNAME_INVALID##
While using TLS, the hostname/IP of the peer did not match any of the
subjectAltNames
in its certificate.
ERR_TLS_DH_PARAM_SIZE##
While using TLS, the parameter offered for the Diffie-Hellman (DH
)
key-agreement protocol is too small. By default, the key length must be greater
than or equal to 1024 bits to avoid vulnerabilities, even though it is strongly
recommended to use 2048 bits or larger for stronger security.
ERR_TLS_HANDSHAKE_TIMEOUT##
A TLS/SSL handshake timed out. In this case, the server must also abort the connection.
ERR_TLS_RENEGOTIATE##
An attempt to renegotiate the TLS session failed.
ERR_TLS_RENEGOTIATION_DISABLED##
An attempt was made to renegotiate TLS on a socket instance with TLS disabled.
ERR_TLS_REQUIRED_SERVER_NAME##
While using TLS, the server.addContext()
method was called without providing
a hostname in the first parameter.
ERR_TLS_SESSION_ATTACK##
An excessive amount of TLS renegotiations is detected, which is a potential vector for denial-of-service attacks.
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.
ERR_TRACE_EVENTS_CATEGORY_REQUIRED##
The trace_events.createTracing()
method requires at least one trace event
category.
ERR_TRACE_EVENTS_UNAVAILABLE##
The trace_events
module could not be loaded because Node.js was compiled with
the --without-v8-platform
flag.
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER##
A SharedArrayBuffer
whose memory is not managed by the JavaScript engine
or by Node.js was encountered during serialization. Such a SharedArrayBuffer
cannot be serialized.
This can only happen when native addons create SharedArrayBuffer
s in
"externalized" mode, or put existing SharedArrayBuffer
into externalized mode.
ERR_TRANSFORM_ALREADY_TRANSFORMING##
A Transform
stream finished while it was still transforming.
ERR_TRANSFORM_WITH_LENGTH_0##
A Transform
stream finished with data still in the write buffer.
ERR_TTY_INIT_FAILED##
The initialization of a TTY failed due to a system error.
ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET##
process.setUncaughtExceptionCaptureCallback()
was called twice,
without first resetting the callback to null
.
This error is designed to prevent accidentally overwriting a callback registered from another module.
ERR_UNESCAPED_CHARACTERS##
A string that contained unescaped characters was received.
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).
ERR_UNKNOWN_BUILTIN_MODULE##
Used to identify a specific kind of internal Node.js error that should not typically be triggered by user code. Instances of this error point to an internal bug within the Node.js binary itself.
ERR_UNKNOWN_ENCODING##
An invalid or unknown encoding option was passed to an API.
ERR_UNKNOWN_FILE_EXTENSION##
An attempt was made to load a module with an unknown or unsupported file extension.
ERR_UNKNOWN_MODULE_FORMAT##
An attempt was made to load a module with an unknown or unsupported format.
ERR_UNKNOWN_SIGNAL##
An invalid or unknown process signal was passed to an API expecting a valid
signal (such as subprocess.kill()
).
ERR_UNKNOWN_STDIN_TYPE##
An attempt was made to launch a Node.js process with an unknown stdin
file
type. This error is usually an indication of a bug within Node.js itself,
although it is possible for user code to trigger it.
ERR_UNKNOWN_STREAM_TYPE##
An attempt was made to launch a Node.js process with an unknown stdout
or
stderr
file type. This error is usually an indication of a bug within Node.js
itself, although it is possible for user code to trigger it.
ERR_V8BREAKITERATOR##
The V8 BreakIterator
API was used but the full ICU data set is not installed.
ERR_VALID_PERFORMANCE_ENTRY_TYPE##
While using the Performance Timing API (perf_hooks
), no valid performance
entry types were found.
ERR_VALUE_OUT_OF_RANGE##
Superseded by ERR_OUT_OF_RANGE
.
ERR_VM_MODULE_ALREADY_LINKED##
The module attempted to be linked is not eligible for linking, because of one of the following reasons:
- It has already been linked (
linkingStatus
is'linked'
) - It is being linked (
linkingStatus
is'linking'
) - Linking has failed for this module (
linkingStatus
is'errored'
)
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.
ERR_VM_MODULE_LINKING_ERRORED##
The linker function returned a module for which linking has failed.
ERR_VM_MODULE_NOT_LINKED##
The module must be successfully linked before instantiation.
ERR_VM_MODULE_NOT_MODULE##
The fulfilled value of a linking promise is not a vm.SourceTextModule
object.
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.
ERR_WORKER_PATH##
The path for the main script of a worker is neither an absolute path
nor a relative path starting with ./
or ../
.
ERR_WORKER_UNSERIALIZABLE_ERROR##
All attempts at serializing an uncaught exception from a worker thread failed.
ERR_WORKER_UNSUPPORTED_EXTENSION##
The pathname used for the main script of a worker has an unknown file extension.
ERR_ZLIB_INITIALIZATION_FAILED##
Creation of a zlib
object failed due to incorrect configuration.
MODULE_NOT_FOUND#
A module file could not be resolved while attempting a require()
or
import
operation.