{ "type": "module", "source": "doc/api/documentation.md", "introduced_in": "v0.10.0", "miscs": [ { "textRaw": "About this documentation", "name": "About this documentation", "introduced_in": "v0.10.0", "type": "misc", "desc": "

Welcome to the official API reference documentation for Node.js!

\n

Node.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.

\n

The stability indices are as follows:

\n
\n

Stability: 0 - Deprecated. The feature may emit warnings. Backward\ncompatibility is not guaranteed.

\n
\n\n
\n

Stability: 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
\n

Stability: 2 - Stable. Compatibility with the npm ecosystem is a high\npriority.

\n
\n\n
\n

Stability: 3 - Legacy. The feature is no longer recommended for use. While it\nlikely will not be removed, and is still covered by semantic-versioning\nguarantees, use of the feature should be avoided.

\n
\n

Use 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": "
APIStability
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
dgram(2) Stable
diagnostics_channel(1) Experimental
dns(2) Stable
domain(0) Deprecated
fs(2) Stable
http(2) Stable
http/2(2) Stable
https(2) Stable
inspector(2) Stable
module(2) Stable
os(2) Stable
path(2) Stable
performance_measurement_apis(2) Stable
punycode(0) Deprecated
querystring(3) Legacy
readline(2) Stable
repl(2) Stable
stream(2) Stable
string_decoder(2) Stable
timers(2) Stable
tls_(ssl)(2) Stable
trace_events(1) Experimental
tty(2) Stable
url(2) Stable
util(2) Stable
vm(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
", "type": "misc", "displayName": "Stability overview" }, { "textRaw": "JSON output", "name": "json_output", "meta": { "added": [ "v0.6.12" ], "changes": [] }, "desc": "

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

", "type": "misc", "displayName": "JSON output" }, { "textRaw": "System calls and man pages", "name": "system_calls_and_man_pages", "desc": "

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.

\n

Most Unix system calls have Windows analogues. Still, behavior differences may\nbe unavoidable.

", "type": "misc", "displayName": "System calls and man pages" } ] } ] }