The goal of this documentation is to comprehensively explain the Node.js\nAPI, both from a reference as well as a conceptual point of view. Each\nsection describes a built-in module or high-level concept.
\nWhere appropriate, property types, method arguments, and the arguments\nprovided to event handlers are detailed in a list underneath the topic\nheading.
\nEvery .html document has a corresponding .json document presenting\nthe same information in a structured manner. This feature is\nexperimental, and added for the benefit of IDEs and other utilities that\nwish to do programmatic things with the documentation.
Every .html and .json file is generated based on the corresponding\n.md file in the doc/api/ folder in Node.js's source tree. The\ndocumentation is generated using the tools/doc/generate.js program.\nThe HTML template is located at doc/template.html.
If errors are found in this documentation, please submit an issue\nor see the contributing guide for directions on how to submit a patch.
\n", "miscs": [ { "textRaw": "Stability Index", "name": "Stability Index", "type": "misc", "desc": "Throughout the documentation are indications of a section's\nstability. The Node.js API is still somewhat changing, and as it\nmatures, certain parts are more reliable than others. Some are so\nproven, and so relied upon, that they are unlikely to ever change at\nall. Others are brand new and experimental, or known to be hazardous\nand in the process of being redesigned.
\nThe stability indices are as follows:
\nStability: 0 - Deprecated\nThis feature is known to be problematic, and changes may be planned. Do\nnot rely on it. Use of the feature may cause warnings to be emitted.\nBackwards compatibility across major versions should not be expected.\nStability: 1 - Experimental\nThis feature is still under active development and subject to non-backwards\ncompatible changes, or even removal, in any future version. Use of the feature\nis not recommended in production environments. Experimental features are not\nsubject to the Node.js Semantic Versioning model.\nNote: Caution must be used when making use of Experimental features,\nparticularly within modules that may be used as dependencies (or dependencies\nof dependencies) within a Node.js application. End users may not be aware that\nexperimental features are being used, and therefore may experience unexpected\nfailures or behavioral changes when changes occur. To help avoid such surprises,\nExperimental features may require a command-line flag to explicitly enable\nthem, or may cause a process warning to be emitted. By default, such warnings\nare printed to stderr and may be handled by attaching a listener to the\nprocess.on('warning') event.
Stability: 2 - Stable\nThe API has proven satisfactory. Compatibility with the npm ecosystem\nis a high priority, and will not be broken unless absolutely necessary.\nEvery HTML file in the markdown has a corresponding JSON file with the\nsame data.
\nThis feature was added in Node.js v0.6.12. It is experimental.
\n", "type": "misc", "displayName": "JSON Output" }, { "textRaw": "Syscalls and man pages", "name": "syscalls_and_man_pages", "desc": "System calls like open(2) and read(2) define the interface between user programs\nand the underlying operating system. Node functions which simply wrap a syscall,\nlike fs.open(), will document that. The docs link to the corresponding man\npages (short for manual pages) which describe how the syscalls work.
Note: some syscalls, like lchown(2), are BSD-specific. That means, for\nexample, that fs.lchown() only works on macOS and other BSD-derived systems,\nand is not available on Linux.
Most Unix syscalls have Windows equivalents, but behavior may differ on Windows\nrelative to Linux and macOS. For an example of the subtle ways in which it's\nsometimes impossible to replace Unix syscall semantics on Windows, see Node\nissue 4760.
\n", "type": "misc", "displayName": "Syscalls and man pages" } ] } ] }