Node.js 文档

本文目录结构

关于本文档

Node.js

本文档是基于nodejs官方文档:https://nodejs.org/dist/latest-v10.x/docs/api/index.html 的;

本文档的目的是从参考和概念的角度全面解释 Node.js 的 API。 每个部分都描述了内置模块或高级概念,在适当的情况下,属性类型、方法参数、以及提供给事件处理函数的参数将在主题标题下方的列表中详细说明


中文API当前 Node.js 版本号

v10.15.3

参与贡献

可以通过联系我进行反馈;

通过微信号/邮件联系。

稳定性指数

在整个文档中都有关于章节稳定性的指示。 Node.js 的 API 仍在不断变化,随着发展成熟,某些部分比其他部分更可靠。 有些是已经被证明、被依赖,它们根本不可能再改变。 有些是全新的和试验性的、或者已知是危险的并且在重新设计的过程中。

  • 废弃
    • 此特性可能会发出警告。 不保证向后兼容性,请不要使用废弃的API了
  • 试验
    • 此特性仍在积极开发中,并且在将来的任何版本中都会受到非向后兼容的更改或删除。 建议不要在生产环境中使用该特性。 试验的特性不受 Node.js 语义版本控制模型的约束。
  • 稳定
    • 与 npm 生态系统的兼容性是最高优先级;本文的中,凡是不标注废弃试验的接口均是稳定的,可以放心使用!

在使用试验的特性时必须谨慎,特别是在可能用作 Node.js 应用程序中的依赖项(或依赖项的依赖项)的模块中。 终端用户可能不知道正在使用试验的特性,因此在 API 修改发生时可能会遇到意外故障或行为更改。 为了避免此类意外,试验的特性可能需要命令行标志才能显式启用它们,或者可能导致发出进程警告。 默认情况下,此类警告会打印到 stderr,并且可以通过将监听器附加到 ‘warning’ 事件来处理。

文档命令说明

本文档中显示的命令以 $> 开头显示,以复制它们在用户终端中的显示方式。 实际使用时不要包含 $ 和 > 字符。 它们用于表明每个命令的开始。

还有许多遵循此约定的教程和示例:

  • $ 或 > 用于作为常规用户运行的命令,
  • # 用于作为管理员执行的命令。

不以 $ 或 > 字符开头的代码行通常显示上一个命令的输出。

首先,确保已经下载并安装了 Node.js。

文档阅读前的准备

你需要有node环境,node环境的检测,可以通过 node -v 来检测

如下图所示

nodejs安装

安装文件可以从官网下载:https://nodejs.org/en/download/

阿西河

AXIHE / 精选教程

浏览全部教程

HTML

CSS

JS

关于本站

阿西河前端教程more,是一个提供大前端开发教程的网站;这里不仅会有传统的WEB开发教程,还会包含Nodejs,Docker,云服务相关的介绍;