- 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/cjsCommonJS模块
- module/esmECMAScript模块
- module/package包模块
- net网络
- os操作系统
- path路径
- perf_hooks性能钩子
- permission权限
- policy安全策略
- process进程
- punycode域名代码
- querystring查询字符串
- readline逐行读取
- repl交互式解释器
- report诊断报告
- stream流
- stream/web网络流
- string_decoder字符串解码器
- test测试
- timers定时器
- tls安全传输层
- trace_events跟踪事件
- tty终端
- url网址
- util实用工具
- v8引擎
- vm虚拟机
- wasi网络汇编系统接口
- worker_threads工作线程
- zlib压缩
Node.js v16.19.1 文档
- Node.js 16.19.1
-
►
目录
- global 全局变量
AbortController
类Buffer
类__dirname
__filename
atob(data)
btoa(data)
clearImmediate(immediateObject)
clearInterval(intervalObject)
clearTimeout(timeoutObject)
console
Crypto
crypto
CryptoKey
CustomEvent
Event
EventTarget
exports
fetch
- FormData 类
global
- Headers 类
MessageChannel
MessageEvent
MessagePort
module
performance
process
queueMicrotask(callback)
require()
Response
Request
setImmediate(callback[, ...args])
setInterval(callback, delay[, ...args])
setTimeout(callback, delay[, ...args])
SubtleCrypto
TextDecoder
TextEncoder
URL
URLSearchParams
WebAssembly
- global 全局变量
-
►
索引
- 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 权限
- policy 安全策略
- process 进程
- punycode 域名代码
- querystring 查询字符串
- readline 逐行读取
- repl 交互式解释器
- report 诊断报告
- stream 流
- stream/web 网络流
- string_decoder 字符串解码器
- test 测试
- timers 定时器
- tls 安全传输层
- trace_events 跟踪事件
- tty 终端
- url 网址
- util 实用工具
- v8 引擎
- vm 虚拟机
- wasi 网络汇编系统接口
- worker_threads 工作线程
- zlib 压缩
- ► 其他版本
- 文档搜索
目录
- global 全局变量
AbortController
类Buffer
类__dirname
__filename
atob(data)
btoa(data)
clearImmediate(immediateObject)
clearInterval(intervalObject)
clearTimeout(timeoutObject)
console
Crypto
crypto
CryptoKey
CustomEvent
Event
EventTarget
exports
fetch
- FormData 类
global
- Headers 类
MessageChannel
MessageEvent
MessagePort
module
performance
process
queueMicrotask(callback)
require()
Response
Request
setImmediate(callback[, ...args])
setInterval(callback, delay[, ...args])
setTimeout(callback, delay[, ...args])
SubtleCrypto
TextDecoder
TextEncoder
URL
URLSearchParams
WebAssembly
global 全局变量#
这些对象在所有模块中都可用。 以下变量可能看起来是全局的,但实际上不是。 它们只存在于模块的作用域中,参见模块系统文档:
此处列出的对象特定于 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); // 打印 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();
// 使用 onabort 属性...
ac.signal.onabort = () => console.log('aborted!');
// 或者 EventTarget API ...
ac.signal.addEventListener('abort', (event) => {
console.log(event.type); // 打印 '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
。
Buffer
类#
用于处理二进制数据。 参阅缓冲区章节。
__dirname
#
此变量可能看起来是全局的,但实际上不是。
参见 __dirname
。
__filename
#
此变量可能看起来是全局的,但实际上不是。
参见 __filename
。
atob(data)
#
Buffer.from(data, 'base64')
。buffer.atob()
的全局别名。
btoa(data)
#
buf.toString('base64')
。buffer.btoa()
的全局别名。
clearImmediate(immediateObject)
#
clearImmediate
在定时器章节进行了描述。
clearInterval(intervalObject)
#
clearInterval
在定时器章节进行了描述。
clearTimeout(timeoutObject)
#
clearTimeout
在定时器章节进行了描述。
console
#
用于打印到标准输出和标准错误。
参阅 console
章节。
Crypto
#
--experimental-global-webcrypto
CLI 标志启用此 API。<Crypto> 的浏览器兼容实现。
只有在编译 Node.js 二进制文件时包含对 node:crypto
模块的支持,此全局才可用。
crypto
#
--experimental-global-webcrypto
CLI 标志启用此 API。Web 加密 API 的浏览器兼容实现。
CryptoKey
#
--experimental-global-webcrypto
CLI 标志启用此 API。<CryptoKey> 的浏览器兼容实现。
只有在编译 Node.js 二进制文件时包含对 node:crypto
模块的支持,此全局才可用。
CustomEvent
#
--experimental-global-customevent
CLI flag.CustomEvent
Web API 的浏览器兼容实现。
Event
#
Event
类的浏览器兼容的实现。
有关更多详细信息,请参阅 EventTarget
和 Event
API。
EventTarget
#
EventTarget
类的浏览器兼容的实现。
有关更多详细信息,请参阅 EventTarget
和 Event
API。
exports
#
此变量可能看起来是全局的,但实际上不是。
参见 exports
。
fetch
#
--experimental-fetch
CLI 标志启用此 API。fetch()
函数的浏览器兼容实现。
FormData 类#
--experimental-fetch
CLI 标志启用此 API。<FormData> 的浏览器兼容实现。
global
#
- <Object> 全局的命名空间对象。
在浏览器中,顶层的作用域是全局作用域。
这意味着在浏览器中,var something
将定义新的全局变量。
在 Node.js 中这是不同的。
顶层作用域不是全局作用域;Node.js 模块内的 var something
将是该模块本地的。
Headers 类#
--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()
队列总是在微任务队列之前处理。
// 在这里,`queueMicrotask()` 用于确保 'load' 事件总是异步地触发,
// 并且因此始终如一。
// 在这里使用 `process.nextTick()` 会导致 'load' 事件
// 总是在任何其他 promise 作业之前触发。
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);
};
require()
#
此变量可能看起来是全局的,但实际上不是。
参见 require()
。
Response
#
--experimental-fetch
CLI 标志启用此 API。<Response> 的浏览器兼容实现。
Request
#
--experimental-fetch
CLI 标志启用此 API。<Request> 的浏览器兼容实现。
setImmediate(callback[, ...args])
#
setImmediate
在定时器章节进行了描述。
setInterval(callback, delay[, ...args])
#
setInterval
在定时器章节进行了描述。
setTimeout(callback, delay[, ...args])
#
setTimeout
在定时器章节进行了描述。
SubtleCrypto
#
--experimental-global-webcrypto
CLI 标志启用此 API。<SubtleCrypto> 的浏览器兼容实现。
只有在编译 Node.js 二进制文件时包含对 node:crypto
模块的支持,此全局才可用。
TextDecoder
#
WHATWG TextDecoder
类。
参阅 TextDecoder
章节。
TextEncoder
#
WHATWG TextEncoder
类。
参阅 TextEncoder
章节。
URL
#
WHATWG URL
类。
参阅 URL
章节。
URLSearchParams
#
WHATWG URLSearchParams
类。
参阅 URLSearchParams
章节。
WebAssembly
#
该对象充当所有 W3C WebAssembly 相关功能的命名空间。 有关用法和兼容性,请参阅 Mozilla 开发者网络。