- assert 断言
- async_hooks 异步钩子
- async_hooks/context 异步上下文
- buffer 缓冲区
- C++插件
- C/C++插件(使用Node-API)
- C++嵌入器
- child_process 子进程
- cluster 集群
- CLI 命令行
- console 控制台
- Corepack 核心包
- crypto 加密
- crypto/webcrypto 网络加密
- debugger 调试器
- deprecation 弃用
- dgram 数据报
- diagnostics_channel 诊断通道
- dns 域名服务器
- domain 域
- Error 错误
- events 事件触发器
- fs 文件系统
- global 全局变量
- http 超文本传输协议
- http2 超文本传输协议2.0
- https 安全超文本传输协议
- inspector 检查器
- Intl 国际化
- module 模块
- module/cjs CommonJS模块
- module/esm ECMAScript模块
- module/package 包模块
- net 网络
- os 操作系统
- path 路径
- perf_hooks 性能钩子
- permission 权限
- process 进程
- punycode 域名代码
- querystring 查询字符串
- readline 逐行读取
- repl 交互式解释器
- report 诊断报告
- sea 单个可执行应用程序
- stream 流
- stream/web 网络流
- string_decoder 字符串解码器
- test 测试
- timers 定时器
- tls 安全传输层
- trace_events 跟踪事件
- tty 终端
- url 网址
- util 实用工具
- v8 引擎
- vm 虚拟机
- wasi 网络汇编系统接口
- worker_threads 工作线程
- zlib 压缩
Node.js v18.16.0 文档
- Node.js v18.16.0
-
►
目录
- 全局对象
- 类:
AbortController
- 类:
Blob
- 类:
Buffer
- 类:
ByteLengthQueuingStrategy
__dirname
__filename
atob(data)
BroadcastChannel
btoa(data)
clearImmediate(immediateObject)
clearInterval(intervalObject)
clearTimeout(timeoutObject)
- 类:
CompressionStream
console
- 类:
CountQueuingStrategy
Crypto
crypto
CryptoKey
CustomEvent
- 类:
DecompressionStream
Event
EventTarget
exports
fetch
FormData
类global
Headers
类MessageChannel
MessageEvent
MessagePort
module
performance
process
queueMicrotask(callback)
- 类:
ReadableByteStreamController
- 类:
ReadableStream
- 类:
ReadableStreamBYOBReader
- 类:
ReadableStreamBYOBRequest
- 类:
ReadableStreamDefaultController
- 类:
ReadableStreamDefaultReader
require()
Response
Request
setImmediate(callback[, ...args])
setInterval(callback, delay[, ...args])
setTimeout(callback, delay[, ...args])
structuredClone(value[, options])
SubtleCrypto
DOMException
TextDecoder
- 类:
TextDecoderStream
TextEncoder
- 类:
TextEncoderStream
- 类:
TransformStream
- 类:
TransformStreamDefaultController
URL
URLSearchParams
WebAssembly
- 类:
WritableStream
- 类:
WritableStreamDefaultController
- 类:
WritableStreamDefaultWriter
- 类:
- 全局对象
-
►
导航
- assert 断言
- async_hooks 异步钩子
- async_hooks/context 异步上下文
- buffer 缓冲区
- C++插件
- C/C++插件(使用Node-API)
- C++嵌入器
- child_process 子进程
- cluster 集群
- CLI 命令行
- console 控制台
- Corepack 核心包
- crypto 加密
- crypto/webcrypto 网络加密
- debugger 调试器
- deprecation 弃用
- dgram 数据报
- diagnostics_channel 诊断通道
- dns 域名服务器
- domain 域
- Error 错误
- events 事件触发器
- fs 文件系统
- global 全局变量
- http 超文本传输协议
- http2 超文本传输协议2.0
- https 安全超文本传输协议
- inspector 检查器
- Intl 国际化
- module 模块
- module/cjs CommonJS模块
- module/esm ECMAScript模块
- module/package 包模块
- net 网络
- os 操作系统
- path 路径
- perf_hooks 性能钩子
- permission 权限
- process 进程
- punycode 域名代码
- querystring 查询字符串
- readline 逐行读取
- repl 交互式解释器
- report 诊断报告
- sea 单个可执行应用程序
- stream 流
- stream/web 网络流
- string_decoder 字符串解码器
- test 测试
- timers 定时器
- tls 安全传输层
- trace_events 跟踪事件
- tty 终端
- url 网址
- util 实用工具
- v8 引擎
- vm 虚拟机
- wasi 网络汇编系统接口
- worker_threads 工作线程
- zlib 压缩
- ► 其他版本
- 云服务器
目录
- 全局对象
- 类:
AbortController
- 类:
Blob
- 类:
Buffer
- 类:
ByteLengthQueuingStrategy
__dirname
__filename
atob(data)
BroadcastChannel
btoa(data)
clearImmediate(immediateObject)
clearInterval(intervalObject)
clearTimeout(timeoutObject)
- 类:
CompressionStream
console
- 类:
CountQueuingStrategy
Crypto
crypto
CryptoKey
CustomEvent
- 类:
DecompressionStream
Event
EventTarget
exports
fetch
FormData
类global
Headers
类MessageChannel
MessageEvent
MessagePort
module
performance
process
queueMicrotask(callback)
- 类:
ReadableByteStreamController
- 类:
ReadableStream
- 类:
ReadableStreamBYOBReader
- 类:
ReadableStreamBYOBRequest
- 类:
ReadableStreamDefaultController
- 类:
ReadableStreamDefaultReader
require()
Response
Request
setImmediate(callback[, ...args])
setInterval(callback, delay[, ...args])
setTimeout(callback, delay[, ...args])
structuredClone(value[, options])
SubtleCrypto
DOMException
TextDecoder
- 类:
TextDecoderStream
TextEncoder
- 类:
TextEncoderStream
- 类:
TransformStream
- 类:
TransformStreamDefaultController
URL
URLSearchParams
WebAssembly
- 类:
WritableStream
- 类:
WritableStreamDefaultController
- 类:
WritableStreamDefaultWriter
- 类:
全局对象#
这些对象在所有模块中都可用。 以下变量可能看起来是全局的,但实际上不是。 它们只存在于模块范围内,见 模块系统文档:
此处列出的对象特定于 Node.js。 内置对象 是 JavaScript 语言本身的一部分,也是全局可访问的。
类:AbortController
#
用于在选定的基于 Promise
的 API 中触发取消信号的实用工具类。
该 API 基于 Web API AbortController
。
const ac = new AbortController();
ac.signal.addEventListener('abort', () => console.log('Aborted!'),
{ once: true });
ac.abort();
console.log(ac.signal.aborted); // Prints True
abortController.abort([reason])
#
reason
<any> 可选的原因,可在AbortSignal
的reason
属性中检索。
触发中止信号,使 abortController.signal
触发 'abort'
事件。
abortController.signal
#
- 类型: <AbortSignal>
类:AbortSignal
#
- 继承: <EventTarget>
AbortSignal
用于在调用 abortController.abort()
方法时通知观察者。
静态方法:AbortSignal.abort([reason])
#
reason
: <any>- 返回: <AbortSignal>
返回新的已中止的 AbortSignal
。
静态方法:AbortSignal.timeout(delay)
#
delay
<number> 触发 AbortSignal 之前等待的毫秒数。
返回新的 AbortSignal
,其将在 delay
毫秒内中止。
事件:'abort'
#
当调用 abortController.abort()
方法时,则触发 'abort'
事件。 使用单个对象参数调用回调,该对象具有被设置为 'abort'
的 type
属性:
const ac = new AbortController();
// Use either the onabort property...
ac.signal.onabort = () => console.log('aborted!');
// Or the EventTarget API...
ac.signal.addEventListener('abort', (event) => {
console.log(event.type); // Prints 'abort'
}, { once: true });
ac.abort();
与 AbortSignal
关联的 AbortController
只会触发一次 'abort'
事件。 建议在添加 'abort'
事件监听器之前代码检查 abortSignal.aborted
属性是否为 false
。
任何绑定到 AbortSignal
的事件监听器都应使用 { once: true }
选项(或者,如果使用 EventEmitter
API 绑定监听器,则使用 once()
方法)以确保在处理 'abort'
事件后立即删除事件监听器。 不这样做可能会导致内存泄漏。
abortSignal.aborted
#
- 类型: <boolean> 中止
AbortController
后为真。
abortSignal.onabort
#
- 类型: <Function>
可选的回调函数,可以由用户代码设置,以便当调用 abortController.abort()
函数时得到通知。
abortSignal.reason
#
- 类型: <any>
当触发 AbortSignal
时指定的可选的原因。
const ac = new AbortController();
ac.abort(new Error('boom!'));
console.log(ac.signal.reason); // Error('boom!');
abortSignal.throwIfAborted()
#
如果 abortSignal.aborted
是 true
,则抛出 abortSignal.reason
。
类:Blob
#
参见 <Blob>。
类:Buffer
#
用于处理二进制数据。 参见 buffer section。
类:ByteLengthQueuingStrategy
#
ByteLengthQueuingStrategy
的浏览器兼容实现。
__dirname
#
此变量可能看起来是全局的,但实际上不是。 参见 __dirname
。
__filename
#
此变量可能看起来是全局的,但实际上不是。 参见 __filename
。
atob(data)
#
Buffer.from(data, 'base64')
。buffer.atob()
的全局别名。
BroadcastChannel
#
btoa(data)
#
buf.toString('base64')
。buffer.btoa()
的全局别名。
clearImmediate(immediateObject)
#
clearImmediate
在 定时器 部分中描述。
clearInterval(intervalObject)
#
clearInterval
在 定时器 部分中描述。
clearTimeout(timeoutObject)
#
clearTimeout
在 定时器 部分中描述。
类:CompressionStream
#
CompressionStream
的浏览器兼容实现。
console
#
用于打印到标准输出和标准错误。 参阅 console
章节。
类:CountQueuingStrategy
#
CountQueuingStrategy
的浏览器兼容实现。
Crypto
#
--experimental-global-webcrypto
CLI 标志启用此 API。<Crypto> 的浏览器兼容实现。 只有在编译 Node.js 二进制文件时包含对 node:crypto
模块的支持,此全局才可用。
crypto
#
--experimental-global-webcrypto
CLI 标志启用此 API。网络加密 API 的浏览器兼容实现。
CryptoKey
#
--experimental-global-webcrypto
CLI 标志启用此 API。<CryptoKey> 的浏览器兼容实现。 只有在编译 Node.js 二进制文件时包含对 node:crypto
模块的支持,此全局才可用。
CustomEvent
#
--experimental-global-customevent
CLI 标志启用此 API。CustomEvent
网络 API 的浏览器兼容实现。
类:DecompressionStream
#
DecompressionStream
的浏览器兼容实现。
Event
#
Event
类的浏览器兼容的实现。 有关详细信息,请参阅 EventTarget
和 Event
API。
EventTarget
#
EventTarget
类的浏览器兼容的实现。 有关详细信息,请参阅 EventTarget
和 Event
API。
exports
#
此变量可能看起来是全局的,但实际上不是。 参见 exports
。
fetch
#
--no-experimental-fetch
CLI 标志禁用此 API。fetch()
函数的浏览器兼容实现。
FormData
类#
--no-experimental-fetch
CLI 标志禁用此 API。<FormData> 的浏览器兼容实现。
global
#
- <Object> 全局的命名空间对象。
在浏览器中,顶层的作用域是全局作用域。 这意味着在浏览器中,var something
将定义新的全局变量。 在 Node.js 中这是不同的。 顶层作用域不是全局作用域;
Node.js 模块内的 var something
将是该模块的本地。
Headers
类#
--no-experimental-fetch
CLI 标志禁用此 API。<Headers> 的浏览器兼容实现。
MessageChannel
#
MessageChannel
类。 有关详细信息,请参阅 MessageChannel
。
MessageEvent
#
MessageEvent
类。 有关详细信息,请参阅 MessageEvent
。
MessagePort
#
MessagePort
类。 有关详细信息,请参阅 MessagePort
。
module
#
此变量可能看起来是全局的,但实际上不是。 参见 module
。
performance
#
process
#
进程对象。 参阅 process
对象 章节。
queueMicrotask(callback)
#
callback
<Function> 要排队的函数。
queueMicrotask()
方法将微任务排队以调用 callback
。 如果 callback
抛出异常,将触发 process
对象 'uncaughtException'
事件。
微任务队列由 V8 管理,并且可以以类似于 process.nextTick()
队列的方式使用,后者由 Node.js 管理。 在 Node.js 事件循环的每次轮询中,process.nextTick()
队列总是在微任务队列之前处理。
// Here, `queueMicrotask()` is used to ensure the 'load' event is always
// emitted asynchronously, and therefore consistently. Using
// `process.nextTick()` here would result in the 'load' event always emitting
// before any other promise jobs.
DataHandler.prototype.load = async function load(key) {
const hit = this._cache.get(key);
if (hit !== undefined) {
queueMicrotask(() => {
this.emit('load', hit);
});
return;
}
const data = await fetchData(key);
this._cache.set(key, data);
this.emit('load', data);
};
类:ReadableByteStreamController
#
ReadableByteStreamController
的浏览器兼容实现。
类:ReadableStream
#
ReadableStream
的浏览器兼容实现。
类:ReadableStreamBYOBReader
#
ReadableStreamBYOBReader
的浏览器兼容实现。
类:ReadableStreamBYOBRequest
#
ReadableStreamBYOBRequest
的浏览器兼容实现。
类:ReadableStreamDefaultController
#
ReadableStreamDefaultController
的浏览器兼容实现。
类:ReadableStreamDefaultReader
#
ReadableStreamDefaultReader
的浏览器兼容实现。
require()
#
此变量可能看起来是全局的,但实际上不是。 参见 require()
。
Response
#
--no-experimental-fetch
CLI 标志禁用此 API。<Response> 的浏览器兼容实现。
Request
#
--no-experimental-fetch
CLI 标志禁用此 API。<Request> 的浏览器兼容实现。
setImmediate(callback[, ...args])
#
setImmediate
在 定时器 部分中描述。
setInterval(callback, delay[, ...args])
#
setInterval
在 定时器 部分中描述。
setTimeout(callback, delay[, ...args])
#
setTimeout
在 定时器 部分中描述。
structuredClone(value[, options])
#
WHATWG structuredClone
方法。
SubtleCrypto
#
--experimental-global-webcrypto
CLI 标志启用此 API。<SubtleCrypto> 的浏览器兼容实现。 只有在编译 Node.js 二进制文件时包含对 node:crypto
模块的支持,此全局才可用。
DOMException
#
WHATWG DOMException
类。 有关详细信息,请参阅 DOMException
。
TextDecoder
#
WHATWG TextDecoder
类。 参阅 TextDecoder
章节。
类:TextDecoderStream
#
TextDecoderStream
的浏览器兼容实现。
TextEncoder
#
WHATWG TextEncoder
类。 参阅 TextEncoder
章节。
类:TextEncoderStream
#
TextEncoderStream
的浏览器兼容实现。
类:TransformStream
#
TransformStream
的浏览器兼容实现。
类:TransformStreamDefaultController
#
TransformStreamDefaultController
的浏览器兼容实现。
URL
#
WHATWG URL
类。 参阅 URL
章节。
URLSearchParams
#
WHATWG URLSearchParams
类。 参阅 URLSearchParams
章节。
WebAssembly
#
充当所有 W3C WebAssembly 相关功能的名称空间的对象。 有关用法和兼容性,请参阅 Mozilla 开发者网络。
类:WritableStream
#
WritableStream
的浏览器兼容实现。
类:WritableStreamDefaultController
#
WritableStreamDefaultController
的浏览器兼容实现。
类:WritableStreamDefaultWriter
#
WritableStreamDefaultWriter
的浏览器兼容实现。