//Description
the Node API version is v0.10.31.
Chinese Reference: http://nodeapi.ucdok.com/#/api/this Keweibo main note.
Directory about this document
0 stability Indicators
0 JSON output
About this documentThe purpose of this document is to interpret the node. JS API from a conceptual overview perspective, both from a reference document perspective. Each section describes a built-in module or a core module compared to the upper layer.
if appropriate, the parameters of the attribute type, method parameters, and event listener are listed in detail under the main heading.
each . html file has a consistent, structured rendering of the . JSON file that represents the same information. This feature is experimental in nature and facilitates the IDE and other tools that want to manipulate the document.
each . html and . JSON file is based on the Doc/api folder under the node source file directory tree . markdown This consistent file creation. This document is generated using the tools/doc/generate.js program. The HTML template is located in doc/template.html . Stability indicators
With this document, you will learn about the stability metrics for each section. The node. JS API is still changing. When some parts mature, it is more reliable than other parts. Other parts are proven and heavily dependent, and they are almost impossible to change. Others are new, experimental, or known to be dangerous and will be redesigned.
The stability indicators are as follows:
Stability: 0-Objection
the feature is known to have problems and changes are already in the plan. Don't rely on it. Using this attribute can cause a warning. and the latter compatibility should not be expected.
Stability: 1-Test
This feature has recently been introduced and may be changed or removed in future versions. You can use and provide feedback. If it applies to a usage scenario that is important to you, please tell the node core team.
Stability: 2- unstable
The API is in a solid process, but there is not enough real-world scenario testing to ensure stability. If possible, the latter compatibility will be provided.
Stability: 3-Stable
the API has been satisfactorily proven, but the cleanup of the underlying code can cause minor changes. The latter compatibility is guaranteed.
Stability: 4-api freeze
These APIs have been extensively tested in production and are unlikely to be changed.
Stability: 5-locked
unless a serious bug is found, the code will not change. Please do not suggest any changes in these places, they will all be ignored.
JSON output
Stability: 1-Test
Each HTML file produced by Markdown has a consistent JSON file with the same data.
This feature was newly introduced in node v0.6.12. It is experimental in nature.
node. js Api--about This documentation (about this document)