Contributing#

Report errors in this documentation inthe issue tracker. Seethe contributing guide for directions on how to submit pull requests.

Stability index#

Throughout the documentation are indications of a section's stability. Some APIsare 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.

The stability indices are as follows:

Features are marked as legacy rather than being deprecated if their use does noharm, and they are widely relied upon within the npm ecosystem. Bugs found inlegacy features are unlikely to be fixed.

Use caution when making use of Experimental features, particularly withinmodules. Users may not be aware that experimental features are being used.Bugs or behavior changes may surprise users when Experimental APImodifications occur. To avoid surprises, use of an Experimental feature may needa command-line flag. Experimental features may also emit awarning.

Stability overview#

JSON output#

Every.html document has a corresponding.json document. This is for IDEsand other utilities that consume the documentation.

System calls and man pages#

Node.js functions which wrap a system call will document that. The docs linkto the corresponding man pages which describe how the system call works.

Most Unix system calls have Windows analogues. Still, behavior differences maybe unavoidable.