Welcome to the official API reference documentation for Node.js!
\nNode.js is a JavaScript runtime built on the V8 JavaScript engine.
", "miscs": [ { "textRaw": "Contributing", "name": "contributing", "desc": "Report errors in this documentation in the issue tracker. See\nthe contributing guide for directions on how to submit pull requests.
", "type": "misc", "displayName": "Contributing" }, { "textRaw": "Stability index", "name": "Stability index", "type": "misc", "desc": "Throughout the documentation are indications of a section's stability. Some APIs\nare so proven and so relied upon that they are unlikely to ever change at all.\nOthers are brand new and experimental, or known to be hazardous.
\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. The feature is not subject to\nsemantic versioning rules. Non-backward compatible changes or removal may\noccur in any future release. Use of the feature is not recommended in\nproduction environments.
\n
\n\n\nStability: 2 - Stable. Compatibility with the npm ecosystem is a high\npriority.
\n
\n\nStability: 3 - Legacy. Although this feature is unlikely to be removed and is\nstill covered by semantic versioning guarantees, it is no longer actively\nmaintained, and other alternatives are available.
\n
Features are marked as legacy rather than being deprecated if their use does no\nharm, and they are widely relied upon within the npm ecosystem. Bugs found in\nlegacy features are unlikely to be fixed.
\nUse caution when making use of Experimental features, particularly within\nmodules. Users may not be aware that experimental features are being used.\nBugs or behavior changes may surprise users when Experimental API\nmodifications occur. To avoid surprises, use of an Experimental feature may need\na command-line flag. Experimental features may also emit a warning.
" }, { "textRaw": "Stability overview", "name": "stability_overview", "desc": "| API | Stability |
|---|---|
| Assert | (2) Stable |
| Async hooks | (1) Experimental |
| Asynchronous context tracking | (2) Stable |
| Buffer | (2) Stable |
| Child process | (2) Stable |
| Cluster | (2) Stable |
| Console | (2) Stable |
| Crypto | (2) Stable |
| Diagnostics Channel | (2) Stable |
| DNS | (2) Stable |
| Domain | (0) Deprecated |
| File system | (2) Stable |
| HTTP | (2) Stable |
| HTTP/2 | (2) Stable |
| HTTPS | (2) Stable |
| Inspector | (2) Stable |
Modules: node:module API | (1) .1 - Active development |
| Modules: CommonJS modules | (2) Stable |
| OS | (2) Stable |
| Path | (2) Stable |
| Performance measurement APIs | (2) Stable |
| Punycode | (0) Deprecated |
| Query string | (2) Stable |
| Readline | (2) Stable |
| REPL | (2) Stable |
| Single executable applications | (1) Experimental: This feature is being designed and will change. |
| Stream | (2) Stable |
| String decoder | (2) Stable |
| Test runner | (1) Experimental |
| Timers | (2) Stable |
| TLS (SSL) | (2) Stable |
| Trace events | (1) Experimental |
| TTY | (2) Stable |
| UDP/datagram sockets | (2) Stable |
| URL | (2) Stable |
| Util | (2) Stable |
| VM (executing JavaScript) | (2) Stable |
| Web Crypto API | (1) Experimental |
| Web Streams API | (1) Experimental. |
| WebAssembly System Interface (WASI) | (1) Experimental |
| Worker threads | (2) Stable |
| Zlib | (2) Stable |
Every .html document has a corresponding .json document. This is for IDEs\nand other utilities that consume the documentation.
Node.js functions which wrap a system call will document that. The docs link\nto the corresponding man pages which describe how the system call works.
\nMost Unix system calls have Windows analogues. Still, behavior differences may\nbe unavoidable.
", "type": "misc", "displayName": "System calls and man pages" } ] } ] }