{
  "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": "<p>Welcome to the official API reference documentation for Node.js!</p>\n<p>Node.js is a JavaScript runtime built on the <a href=\"https://v8.dev/\">V8 JavaScript engine</a>.</p>",
      "miscs": [
        {
          "textRaw": "Contributing",
          "name": "contributing",
          "type": "misc",
          "desc": "<p>Report errors in this documentation in <a href=\"https://github.com/nodejs/node/issues/new\">the issue tracker</a>. See\n<a href=\"https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md\">the contributing guide</a> for directions on how to submit pull requests.</p>",
          "displayName": "Contributing"
        },
        {
          "textRaw": "Stability index",
          "name": "Stability index",
          "type": "misc",
          "desc": "<p>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.</p>\n<p>The stability indexes are as follows:</p>\n<blockquote>\n<p><a href=\"documentation.html#stability-index\">Stability: 0</a> - Deprecated. The feature may emit warnings. Backward\ncompatibility is not guaranteed.</p>\n</blockquote>\n<blockquote>\n<p>Stability: 1 - Experimental. The feature is not subject to\n<a href=\"https://semver.org/\">semantic versioning</a> rules. Non-backward compatible changes or removal may\noccur in any future release. Use of the feature is not recommended in\nproduction environments.</p>\n<p>Experimental features are subdivided into stages:</p>\n<ul>\n<li>1.0 - Early development. Experimental features at this stage are unfinished\nand subject to substantial change.</li>\n<li>1.1 - Active development. Experimental features at this stage are nearing\nminimum viability.</li>\n<li>1.2 - Release candidate. Experimental features at this stage are hopefully\nready to become stable. No further breaking changes are anticipated but may\nstill occur in response to user feedback or the features' underlying\nspecification development. We encourage user testing and feedback so that\nwe can know that this feature is ready to be marked as stable.</li>\n</ul>\n<p>Experimental features leave the experimental status typically either by\ngraduating to stable, or are removed without a deprecation cycle.</p>\n</blockquote>\n<blockquote>\n<p>Stability: 2 - Stable. Compatibility with the npm ecosystem is a high\npriority.</p>\n</blockquote>\n<blockquote>\n<p>Stability: 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.</p>\n</blockquote>\n<p>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.</p>\n<p>Use caution when making use of Experimental features, particularly when\nauthoring libraries. Users may not be aware that experimental features are being\nused. Bugs 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 <a href=\"process.html#event-warning\">warning</a>.</p>"
        },
        {
          "textRaw": "Stability overview",
          "name": "stability_overview",
          "type": "misc",
          "displayName": "Stability overview"
        },
        {
          "textRaw": "JSON output",
          "name": "json_output",
          "type": "misc",
          "meta": {
            "added": [
              "v0.6.12"
            ],
            "changes": []
          },
          "desc": "<p>Every <code>.html</code> document has a corresponding <code>.json</code> document. This is for IDEs\nand other utilities that consume the documentation.</p>",
          "displayName": "JSON output"
        },
        {
          "textRaw": "System calls and man pages",
          "name": "system_calls_and_man_pages",
          "type": "misc",
          "desc": "<p>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.</p>\n<p>Most Unix system calls have Windows analogues. Still, behavior differences may\nbe unavoidable.</p>",
          "displayName": "System calls and man pages"
        }
      ]
    }
  ]
}