Skip to content

关于此文档

欢迎来到 Node.js 的官方 API 参考文档!

Node.js 是一个基于 V8 JavaScript 引擎 构建的 JavaScript 运行时。

贡献

请在 问题跟踪器 中报告此文档中的错误。 有关如何提交拉取请求的说明,请参阅 贡献指南

稳定性指标

整个文档中都有关于某个章节稳定性的说明。 一些 API 已经被证明并且被广泛依赖,以至于它们不太可能发生任何变化。 其他的是全新的和实验性的,或者已知是有风险的。

稳定性指标如下:

[稳定度:0 - 已弃用]

稳定度:0 稳定度:0 - 已弃用。 该特性可能会发出警告。 不保证向后兼容性。

[稳定度:1 - 实验性]

稳定度:1 稳定度:1 - 实验性。 该特性不受 语义版本控制 规则的约束。 在未来的任何版本中都可能发生不向后兼容的更改或删除。 不建议在生产环境中使用该特性。

[稳定度:2 - 稳定]

稳定度:2 稳定度:2 - 稳定。 与 npm 生态系统的兼容性是重中之重。

[稳定度:3 - 遗留]

稳定度:3 稳定度:3 - 遗留。 尽管此特性不太可能被删除并且仍然受到语义版本控制保证的保护,但它不再被积极维护,并且有其他替代方案可用。

如果遗留特性的使用没有危害,并且它们在 npm 生态系统中被广泛依赖,则这些特性会被标记为遗留而不是被弃用。 遗留特性中发现的错误不太可能被修复。

使用实验性特性时要小心,尤其是在编写库时。 用户可能不知道正在使用实验性特性。 当实验性 API 修改发生时,错误或行为更改可能会让用户感到惊讶。 为了避免意外,实验性特性的使用可能需要命令行标志。 实验性特性也可能会发出 警告

稳定性概览

API稳定性
Assert
(2) 稳定
Async hooks
(1) 实验性
Asynchronous context tracking
(2) 稳定
Buffer
(2) 稳定
Child process
(2) 稳定
Cluster
(2) 稳定
Console
(2) 稳定
Crypto
(2) 稳定
Diagnostics Channel
(2) 稳定
DNS
(2) 稳定
Domain
(0) 已弃用
File system
(2) 稳定
HTTP
(2) 稳定
HTTP/2
(2) 稳定
HTTPS
(2) 稳定
Inspector
(2) 稳定
Modules: node:module API
(1) .2 - 发布候选版本(异步版本)稳定性:1.1 - 积极开发(同步版本)
Modules: CommonJS modules
(2) 稳定
Modules: TypeScript
(1) .1 - 积极开发
OS
(2) 稳定
Path
(2) 稳定
Performance measurement APIs
(2) 稳定
Punycode
(0) 已弃用
Query string
(2) 稳定
Readline
(2) 稳定
REPL
(2) 稳定
Single executable applications
(1) .1 - 积极开发
SQLite
(1) .1 - 积极开发。
Stream
(2) 稳定
String decoder
(2) 稳定
Test runner
(2) 稳定
Timers
(2) 稳定
TLS (SSL)
(2) 稳定
Trace events
(1) 实验性
TTY
(2) 稳定
UDP/datagram sockets
(2) 稳定
URL
(2) 稳定
Util
(2) 稳定
VM (executing JavaScript)
(2) 稳定
Web Crypto API
(2) 稳定
Web Streams API
(2) 稳定
WebAssembly System Interface (WASI)
(1) 实验性
Worker threads
(2) 稳定
Zlib
(2) 稳定

JSON 输出

添加于: v0.6.12

每个 .html 文档都有一个对应的 .json 文档。这适用于 IDE 和其他使用文档的实用程序。

系统调用和 man 手册

封装系统调用的 Node.js 函数会记录这一点。文档链接到相应的 man 手册,其中描述了系统调用的工作方式。

大多数 Unix 系统调用都有 Windows 对应物。 尽管如此,行为差异可能是不可避免的。