关于此文档

关于此文档

该文档将从同时使用和概念两个方面详细的介绍 Node.js 的API,每一个章节都将描述了一个内建模块或高级概念。

引用,数据类型,方法的参数以及事件提供的参数都将被详细的列举在标题的下方。

每一个.html文件都有一个与之对应的.json文件,用结构化的方式表述相同的内容。这个功能是实验性的,用以增强对IDE的支持以及其他与文档相关的事务。

每一个.html与.json文件都基于node资源树中doc/api/文件夹内相对应的.macrkdown文件。该文档使用tools/doc/generate.js程序生成的,其HTML模板为 doc/temlplate.html文件。

稳定性标识

在整篇文档中,我们将看到章节的稳定性标识。Node.js的API是在不断变化的,随着它的成熟,其中一些部分必然比其他部分更加稳定。那些被证明可信赖的部分将不会被改变,而一些新的实验性的分支,或者有害的部分将被重新设计。

以下是稳定性标识:

稳定性 0 弃用的
这项功能被证明是有问题的,并且正在被计划修改。请不要依赖于它。使用这个功能将会导致一些警告以及一些不可预知的兼容性问题。

稳定性 1 实验性的
这样功能是最近被引进,有可能在将来的版本中被更改或移除。请试着使用它并提交反馈。如果他解决了一个对你来说非常重要的用例,请告知node核心小组。

稳定性 2 不稳定的
这个API正在稳定的过程中,但是还没有经过足够的测试证明其足够稳定。如果合理的话,向后的兼容性将被保留。

稳定性 3 稳定的
这个API被充分的证明,但在清理底层代码时将导致一些细微的变化。向后的兼容性将被保证。

稳定性 4 API冻结
这个API在产品中经过了大量的测试,并不再准备改变。

稳定性 5 锁定的
除非发现了非常严重得缺陷,否则这段代码将不再被更改。请不要建议更改这个部分,这些建议将被拒绝。

JSON输出

稳定性 1 实验性的
在markdown中,每一个HTML文件都有一个与之对应的,拥有相同数据的json文件。
这个功能始于v0.6.12版本,是一个实验性的功能。
时间: 2024-12-21 14:18:11

关于此文档的相关文章

InfoPath错误,此文档库已被重命名或删除

在使用InfoPath发布表单,发布到SharePoint服务器报错,如下介绍: 环境:Windows 2012 DateCenter + Sql 2012 + SharePoint 2013 + Office 2013 错误截图 错误描述 InfoPath无法保存下列表单:http://url/InfoPathLibary 此文档库已被重命名或删除,或者网络问题导致文件无法保存.如果此问题持续存在,请于网络管理员联系. 解决方法 启用Windows系统的“桌面体验”功能,启用过程如下: 截图可

EXCEL保存提示“隐私问题警告:此文档中包含宏……”解决办法

先点击"禁止宏运行"的那个按钮.打开文件后,按alt + F11 进入宏编辑器,在"工程"里查看是什么宏.如果是你需要的,就留着.否则右击这个宏名称,选择"移除". 另外,如果是你需要的,还需要在 工具→宏→安全性 里设成"低".这样就不会每次都提示了.(不过可能会有安全隐患) ------------------------------------------------------------- 方法一:点击Excel 上

微信JS-SDK说明文档及常见问题处理

概述 微信JS-SDK是微信公众平台面向网页开发者提供的基于微信内的网页开发工具包. 通过使用微信JS-SDK,网页开发者可借助微信高效地使用拍照.选图.语音.位置等手机系统的能力,同时可以直接使用微信分享.扫一扫.卡券.支付等微信特有的能力,为微信用户提供更优质的网页体验. 此文档面向网页开发者介绍微信JS-SDK如何使用及相关注意事项. 使用说明 在使用微信JS-SDK对应的JS接口前,需确保公众号已获得使用对应JS接口的权限,可登录微信公众平台进入“开发者中心”查看对应的接口权限. 注意:

关于微信二次分享,描述变链接的解决方法(一)----文档说明

http://www.cnblogs.com/joshua317/p/4761948.html 前言: 最近工作中遇到了使用微信二次分享的时候,标题被截短,描述也变成了链接,图片也没有,运营人员半夜还在嚷嚷,无奈只好硬着头皮去百度,去google,但是悲催的是没有详细的解决方法,最终只能自己去研究,还好最终搞出来了,决定分享一下,帮助需要的人.博文,分两篇,第一篇主要是微信的官方文档说明,第二篇主要是代码部分: 一.微信JS-SDK说明文档 1.概述 微信JS-SDK是微信公众平台面向网页开发者

WEB前端开发规范文档

规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度. 文件规范 1. html, css, js, images文件均归档至约定的目录中;

Xcode 利用VVDocumenter 生成注释 通过设置 再生成注释文档

在写代码的时候,如果按照一定的规范在头文件里写上注释的话, 就可以利用Xcode的文档自动输出功能生成一份完整的HTML项目文档. 生成的格式和Apple Developer网站上的API文档几乎是一样的. 我们来看看如何利用Xcode生成项目文档.步骤:1. 在XCode里点击Project,然后点Add Target给项目添加一个TARGET 2. 在添加Target的弹出对话框里,选择Aggregate,点击Next,输入一个你喜欢的名字,点击Finish 3. 你会发现TARGETS下面

Web前端开发规范文档(google规范)

(Xee:其实没什么规范约束,但是养成一种好习惯,何乐而不为?) 我推荐去看看google的开发规范,然后从他的当中去总结自己的开发规范. Google HTML/CSS代码风格指南 Google JavaScript 编码规范指南 ------------------------------------------------------------------------------------------------------------------------------- 绝大多数项

【VMware虚拟化解决方案】VMware Horizon View Client 各平台配置文档

云桌面用户手册 XXXX部 2014年05月18日 文档版本 文档名称 XXXX公司云桌面用户手册 保密级别 商密 文档版本编号 1.0 制作人 制作日期 2014-04-24 复审人 复审日期 扩散范围 公司内部使用人员 变更记录 版本编号 版本日期 修改者 说明 文档说明 此文档为XXXX公司内部员工关于<云桌面用户手册>培训文档. 此文档只对公司内部员工传阅,并只针对公司内部员工问题给予解决. 目录 1.VMware Horizon View Client下载地址... 4 2.桌面连接

MongoDB实战-面向文档的数据(找到最合适的数据建模方式)

前一段时间一直研究通过Ruby操作MongoDB数据库,在学习的过程中也分享了自己学习成长的过程,撰写了包含两篇入门操作文章和十二篇进阶文章.本篇文章开始,我们将进入MongoDB的实战操作流程,MongoDB这一非关系型数据库-是一个文档型数据库,存储的是面向文档的数据. 如何在MongoDB数据库中使用schema 设计数据库schema是在已知数据库系统特性.数据本质以及应用程序需求的情况下为数据集选择最佳表述的过程.传统的关系型数据库RDBMS中鼓励使用正规化的数据模型,从而确保数据的可