资讯专栏INFORMATION COLUMN

Node.js API参考文档(关于文档)

xorpay / 1383人阅读

摘要:关于文档本文档的目的是从参考和概念的角度全面解释,每个部分都描述了内置模块或高级概念。文档链接到相应的手册页手册页的简称,描述了系统调用的工作方式。上一篇参考文档目录下一篇用法和示例

关于文档

本文档的目的是从参考和概念的角度全面解释Node.js API,每个部分都描述了内置模块或高级概念。

在适当的情况下,属性类型、方法参数和提供给事件处理程序的参数将在主题标题下方的列表中详细说明。

贡献

如果在本文档中发现错误,请提交问题或参阅有关如何提交补丁的说明的贡献指南。

每个文件都是根据Node.js源代码树中doc/api/文件夹中相应的.md文件生成的,使用tools/ doc/generate.js程序生成文档,HTML模板位于doc/template.html

稳定性指数

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

稳定性指数如下:

稳定性:0 - 弃用,该功能可能会发出警告,不保证向后兼容性。
稳定性:1 - 实验,此功能仍在积极开发中,并且在将来的任何版本中都会受到非向后兼容的更改或删除,建议不要在生产环境中使用该功能,实验功能不受Node.js语义版本控制模型的约束。
稳定性:2 - 稳定,与npm生态系统的兼容性是一个高优先级。

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

JSON输出

添加于:v0.6.12

稳定性:1 - 实验

每个.html文档都有一个相应的.json文档,以结构化的方式呈现相同的信息,此功能是实验性的,并且为了IDE和其他希望使用文档执行编程工作的实用程序的效益而添加。

系统调用和手册页

像open(2)和read(2)这样的系统调用定义了用户程序和底层操作系统之间的接口,简单地包装系统调用的Node.js函数,如fs.open(),将记录它。文档链接到相应的手册页(手册页的简称),描述了系统调用的工作方式。

大多数Unix系统调用都有Windows等价的,但Windows相对于Linux和macOS的行为可能不同,有关在Windows上有时无法替换Unix系统调用语义的微妙方法的示例,请参阅Node.js issue 4760。

上一篇:Node.js API参考文档(目录) 下一篇:用法和示例

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/99166.html

相关文章

  • Node.js API参考文档(目录)

    摘要:参考文档是基于的引擎构建的运行时。关于文档用法和示例断言测试稳定性稳定模块提供了一组简单的断言测试,可用于测试不变量。存在和模式,但建议仅使用模式。类在全局作用域内,因此不太可能需要使用。以下所有示例均可供下载,可用作扩展库的起点。 Node.js v11.5.0 API参考文档 Node.js®是基于Chrome的V8 JavaScript引擎构建的JavaScript运行时。 关...

    stormzhang 评论0 收藏0
  • 【译文】Node.js官方文档(Part 1 关于文档

    摘要:关于本文档本文档的目的,是全面地解释的,即可作为参考文档,同时也包含了概念的讲解。但有的全新的实验性的,或者存在危险性的部分则会被重新设计。稳定级别锁定只会有安全性能或相关的修复。不接受对此做修改的建议。 关于本文档 本文档的目的,是全面地解释Node.js的API,即可作为参考文档,同时也包含了概念的讲解。每个章节都描述了一个内置模块或一个高阶概念(high-level concep...

    svtter 评论0 收藏0
  • Node.js API参考文档(用法和示例)

    摘要:用法和示例有关使用运行脚本的不同选项和方法的信息,请参阅命令行选项文档。现在,创建一个名为的空项目文件夹,然后导航到它,可以根据用户当前的项目标题命名项目文件夹,但此示例将使用作为项目文件夹。文档中的许多示例都可以类似地运行。 用法和示例 node [options] [V8 options] [script.js | -e script | - ] [arguments] 有关使用N...

    mzlogin 评论0 收藏0
  • Koa v2.x 中文文档

    摘要:的对象提供了用于处理响应的方法,该响应委托给。应用对象是与的服务器和处理中间件注册的接口,从发送到中间件,默认错误处理,以及上下文,请求和响应对象的配置。 此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star. showImg(https://segmentfault.com/img/bVNQYf...

    Cobub 评论0 收藏0
  • 前端资源系列(4)-前端学习资源分享&前端面试资源汇总

    摘要:特意对前端学习资源做一个汇总,方便自己学习查阅参考,和好友们共同进步。 特意对前端学习资源做一个汇总,方便自己学习查阅参考,和好友们共同进步。 本以为自己收藏的站点多,可以很快搞定,没想到一入汇总深似海。还有很多不足&遗漏的地方,欢迎补充。有错误的地方,还请斧正... 托管: welcome to git,欢迎交流,感谢star 有好友反应和斧正,会及时更新,平时业务工作时也会不定期更...

    princekin 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<