mirror of
https://github.com/nodejs/node.git
synced 2024-11-30 23:43:09 +01:00
a69ab27ab4
This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
69 lines
2.3 KiB
Markdown
69 lines
2.3 KiB
Markdown
# About this Documentation
|
|
|
|
<!-- type=misc -->
|
|
|
|
The goal of this documentation is to comprehensively explain the Node.js
|
|
API, both from a reference as well as a conceptual point of view. Each
|
|
section describes a built-in module or high-level concept.
|
|
|
|
Where appropriate, property types, method arguments, and the arguments
|
|
provided to event handlers are detailed in a list underneath the topic
|
|
heading.
|
|
|
|
Every `.html` document has a corresponding `.json` document presenting
|
|
the same information in a structured manner. This feature is
|
|
experimental, and added for the benefit of IDEs and other utilities that
|
|
wish to do programmatic things with the documentation.
|
|
|
|
Every `.html` and `.json` file is generated based on the corresponding
|
|
`.markdown` file in the `doc/api/` folder in Node.js's source tree. The
|
|
documentation is generated using the `tools/doc/generate.js` program.
|
|
The HTML template is located at `doc/template.html`.
|
|
|
|
## Stability Index
|
|
|
|
<!--type=misc-->
|
|
|
|
Throughout the documentation, you will see indications of a section's
|
|
stability. The Node.js API is still somewhat changing, and as it
|
|
matures, certain parts are more reliable than others. Some are so
|
|
proven, and so relied upon, that they are unlikely to ever change at
|
|
all. Others are brand new and experimental, or known to be hazardous
|
|
and in the process of being redesigned.
|
|
|
|
The stability indices are as follows:
|
|
|
|
```
|
|
Stability: 0 - Deprecated
|
|
This feature is known to be problematic, and changes are
|
|
planned. Do not rely on it. Use of the feature may cause warnings. Backwards
|
|
compatibility should not be expected.
|
|
```
|
|
|
|
```
|
|
Stability: 1 - Experimental
|
|
This feature is subject to change, and is gated by a command line flag.
|
|
It may change or be removed in future versions.
|
|
```
|
|
|
|
```
|
|
Stability: 2 - Stable
|
|
The API has proven satisfactory. Compatibility with the npm ecosystem
|
|
is a high priority, and will not be broken unless absolutely necessary.
|
|
```
|
|
|
|
```
|
|
Stability: 3 - Locked
|
|
Only fixes related to security, performance, or bug fixes will be accepted.
|
|
Please do not suggest API changes in this area; they will be refused.
|
|
```
|
|
|
|
## JSON Output
|
|
|
|
Stability: 1 - Experimental
|
|
|
|
Every HTML file in the markdown has a corresponding JSON file with the
|
|
same data.
|
|
|
|
This feature was added in node v0.6.12. It is experimental.
|