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

2018-11-10 admin

本文档的目的是从参考和概念的角度全面解释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


原文链接:https://segmentfault.com/a/1190000016970178

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-45053.html

文章标题:Node.js API参考文档(关于文档)

相关文章
html5 参考手册chm
下载地址:html5参考手册chm 友情提示:如果打开空白,在手册上右键属性解除锁定即可。 ...
2015-11-12
关于Ajax应用开发需要注意的事项
接触Ajax,那时候的Ajax支持还不是很好,都要涉及底层,没有现成的框架给你调用。现在把常见的问题列举如下。 [b]1、编码问题[/b] 注意AJAX要取的文件是UTF-8编码的。GB2312编码传回BROWSE后中文会乱码。如果用VBS...
2015-11-11
javascript教程:关于if简写语句优化的方法
UglifyJS是一个对javascript进行压缩和美化的工具,在它的文档说明中,我看到了几种关于if语句优化的方法。尽管我还没使用它去做一些尝试性的测试,但从这里可以看到它的确对js作了美化的工作。也许有人认为if语句就那么简单,能优化...
2015-11-12
Node.js将向移动端扩展
如果你还没有听过Node.js,那么现在就可以了解一下! 目前,来自200多个国家的数以万计的组织在使用Node.js,在Node.js的网站上,每月都有超过200万次下载。但版本发布缓慢使开发人员日益不满,网上出现了创建Node.js分支...
2015-11-12
Node.js v0.11.16 开发版发布
Node.js v0.11.16 开发版发布了,改进记录包括: openssl: Upgrade to 1.0.1l npm: Upgrade to 2.3.0 url: revert support of path for url.fo...
2015-11-12
关于本教程
你应该已经知道什么? 本教程假定您有以下基本的知识: 有一个大体的了解互联网和万维网( www )。 良好的工作知识的超文本标记语言( html )。 一些编程经验。 ...
2015-11-12
vue-awesome-swiper的使用以及API整理
一、先说一个看关于vue-awesome-swiper的一个坑 vue项目的package.json中显示的<span style=“color: orange;”>“vue-awesome-swiper”: “^2.5.4”&...
2018-04-26
Node.js深受欢迎的六大原因
Node.js鏄�涓€绉嶅悗璧风殑浼樼�€鏈嶅姟鍣ㄧ紪绋嬭��瑷€锛屽畠鐢ㄦ潵鏋勫缓鍜岃繍琛學eb搴旂敤锛岃繖鍜孉SP.NET锛孯uby聽on聽Rails鎴朣pring妗嗘灦鍋氱殑宸ヤ綔鏄�绫讳技鐨勩€傚畠浣跨敤JavaScript浣滀负涓...
2015-11-11
Node.js实现Excel转JSON
一直在做一个关于网上选课的系统,选用了时下比较流行的node.js。今天在想怎么把学生或者老师的信息导入进去,涉及数量比较多一点,我手边又正好有一部分excel的表格。就想把excel转成json然后倒入到mongodb中去。 搜了下网上的...
2017-03-23
关于JavaScript
JavaScript是什么? JavaScript是一个跨平台的、面向对象的脚本语言,这是一个小而轻语言,入门十分简单。 JavaScript对象包含一个标准库,如 数组 , 日期 , math 和一组核心的语言元素,如运算符,控制结构和语...
2015-11-12
回到顶部