当前位置: 首页 > 后端技术 > Node.js

Node.jsAPIReferenceDocumentation(AboutDocumentation)

时间:2023-04-03 13:12:17 Node.js

AboutDocumentation本文档的目的是从参考和概念的角度全面解释Node.jsAPI,每个部分描述一个内置模块或高级概念。在适当的情况下,提供给事件处理程序的属性类型、方法参数和自变量在主题标题下方的列表中进行了详细说明。贡献如果您在本文档中发现错误,请提交问题或查看贡献指南以获取有关如何提交补丁的说明。每个文件都是从Node.js源代码树中doc/api/文件夹中相应的.md文件生成的。文档是使用tools/doc/generate.js程序生成的,HTML模板位于doc/template.html。稳定性指标整个文档中都有章节稳定性指标,Node.jsAPI仍在不断变化,随着它的成熟,一些部分比其他部分更可靠,一些已经被证明,如此依赖,它们根本不可能改变,其他是全新的和实验性的,或者已知是危险的并且正在重新设计的过程中。稳定性指数如下:Stability:0-Deprecated,该功能可能会发出警告,不保证向后兼容性。稳定性:1-实验性,此功能仍在积极开发中,可能会在未来的任何版本中进行非向后兼容更改或删除,不建议在生产环境中使用此功能,Node不支持实验性功能。js语义版本控制模型的约束。稳定性:2-稳定,与npm生态系统的兼容性是重中之重。使用实验特性时必须小心,特别是在Node.js应用程序中可能用作依赖项(或依赖项的依赖项)的模块中。最终用户可能不知道正在使用实验性功能,因此在API修改时可能会遇到意外故障或行为更改。为避免此类意外,实验性功能可能需要命令行标志才能明确启用它们,或者可能会导致发出进程警告。此类警告默认打印到stderr,可以通过将侦听器附加到“警告”事件来处理。JSON输出添加于:v0.6.12稳定性:1-实验性每个.html文档都有一个相应的.json文档以结构化方式呈现相同的信息,此功能是实验性的,旨在用于IDE和其他希望添加的实用程序的好处使用文档执行编程工作。系统调用和手册页open(2)和read(2)等系统调用定义了用户程序和底层操作系统之间的接口,简单包装系统调用的Node.js函数,如fs.open(),将记录它。该文档链接到描述系统调用如何工作的相应手册页(手册页的缩写)。大多数Unix系统调用都具有Windows等价物,但Windows的行为可能与Linux和macOS不同,请参阅Node.js问题4760以了解Unix系统调用语义有时无法在Windows上被替换的微妙方式示例。Previous:Node.jsAPI参考文档(目录)Next:用法和示例