{
  "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",
          "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/master/CONTRIBUTING.md\">the contributing guide</a> for directions on how to submit pull requests.</p>",
          "type": "misc",
          "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 indices are as follows:</p>\n<blockquote>\n<p>Stability: 0 - Deprecated. The feature may emit warnings. Backward\ncompatibility is not guaranteed.</p>\n</blockquote>\n<!-- separator -->\n<blockquote>\n<p>Stability: 1 - Experimental. The feature is not subject to Semantic Versioning\nrules. Non-backward compatible changes or removal may occur in any future\nrelease. Use of the feature is not recommended in production environments.</p>\n</blockquote>\n<!-- separator -->\n<blockquote>\n<p>Stability: 2 - Stable. Compatibility with the npm ecosystem is a high\npriority.</p>\n</blockquote>\n<p>Use caution when making use of Experimental features, particularly within\nmodules. End users may not be aware that experimental features are being used.\nBugs or behavior changes may surprise end 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#process_event_warning\">warning</a>.</p>"
        },
        {
          "textRaw": "JSON Output",
          "name": "json_output",
          "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>",
          "type": "misc",
          "displayName": "JSON Output"
        },
        {
          "textRaw": "Syscalls and man pages",
          "name": "syscalls_and_man_pages",
          "desc": "<p>System calls like <a href=\"http://man7.org/linux/man-pages/man2/open.2.html\"><code>open(2)</code></a> and <a href=\"http://man7.org/linux/man-pages/man2/read.2.html\"><code>read(2)</code></a> define the interface between user programs\nand the underlying operating system. Node.js functions\nwhich wrap a syscall,\nlike <a href=\"fs.html#fs_fs_open_path_flags_mode_callback\"><code>fs.open()</code></a>, will document that. The docs link to the corresponding man\npages (short for manual pages) which describe how the syscalls work.</p>\n<p>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 <a href=\"https://github.com/nodejs/node/issues/4760\">Node.js\nissue 4760</a>.</p>",
          "type": "misc",
          "displayName": "Syscalls and man pages"
        }
      ]
    }
  ]
}