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.
", "miscs": [ { "textRaw": "Contributing", "name": "contributing", "desc": "If errors are found in this documentation, please submit an issue\nor see the contributing guide for directions on how to submit a patch.
\nEvery file is generated based on the corresponding .md file in the\ndoc/api/ folder in Node.js's source tree. The documentation is generated\nusing the tools/doc/generate.js program. An HTML template is located at\ndoc/template.html.
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:
\n\n\n\nStability: 0 - Deprecated. The feature may emit warnings. Backward\ncompatibility is not guaranteed.
\n
\n\n\nStability: 1 - Experimental. This feature is still under active development\nand subject to non-backward compatible changes or removal in any future\nversion. Use of the feature is not recommended in production environments.\nExperimental features are not subject to the Node.js Semantic Versioning\nmodel.
\n
\n\nStability: 2 - Stable. Compatibility with the npm ecosystem is a high\npriority.
\n
Caution must be used when making use of Experimental features, particularly\nwithin modules that may be used as dependencies (or dependencies of\ndependencies) within a Node.js application. End users may not be aware that\nexperimental features are being used, and therefore may experience unexpected\nfailures or behavior changes when API modifications occur. To help avoid such\nsurprises, Experimental features may require a command-line flag to\nexplicitly enable them, or may cause a process warning to be emitted.\nBy default, such warnings are printed to stderr and may be handled by\nattaching a listener to the 'warning' event.
Every .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.
System calls like open(2) and read(2) define the interface between user programs\nand the underlying operating system. Node.js functions\nwhich 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.
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.js\nissue 4760.
", "type": "misc", "displayName": "Syscalls and man pages" } ] } ] }