About this document

About this document

This document will detail the node. JS API from both the use and concept two aspects, each of which will describe a built-in module or advanced concept.

References, data types, method parameters, and event-supplied parameters are listed below the headings in detail.

Each. html file has a corresponding. json file that expresses the same content in a structured way. This feature is experimental to enhance support for the IDE and other documentation-related transactions.

Each. html and. Json files are based on the corresponding. macrkdown file within the doc/api/folder in the node resource tree. The document is generated using the Tools/doc/generate.js program and its HTML template is a doc/temlplate.html file.

Stability Identification

Throughout this document, we will see the stability identification of the chapter. The API for node. JS is constantly changing, and as it matures, some of these parts are necessarily more stable than others. Those that have been proven trustworthy will not be altered, and some new experimental branches, or harmful ones, will be redesigned.

The following are the stability identifiers:

01 2 345  Locked unless a very serious flaw is found, this code will no longer be changed. Please do not suggest changing this section, these suggestions will be rejected.

JSON output

1 Experimental

In markdown, each HTML file has a corresponding JSON file that has the same data.

This feature starts with the v0.6.12 version and is an experimental feature.

About this document