{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.0.json","id":"index","path":"/index","type":"misc","module":null,"title":"About this documentation","introducedIn":"v0.10.0","sourceLink":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Welcome to the official API reference documentation for Node.js!\n\nNode.js is a JavaScript runtime built on the [V8 JavaScript engine](https://v8.dev/).","summary":"Welcome to the official API reference documentation for Node.js!","examples":[],"children":[{"kind":"section","id":"contributing","name":"Contributing","title":"Contributing","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Report errors in this documentation in [the issue tracker](https://github.com/nodejs/node/issues/new). See\n[the contributing guide](https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md) for directions on how to submit pull requests.","summary":"Report errors in this documentation in the issue tracker. See the contributing guide for directions on how to submit pull requests.","examples":[],"children":[]},{"kind":"section","id":"stability-index","name":"Stability index","title":"Stability index","scope":"module","overloadOf":null,"stability":{"index":"3","description":"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."},"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"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\nThe stability indexes are as follows:\n\nFeatures 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.\n\nUse 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 [warning](process.html#event-warning).","summary":"Throughout the documentation are indications of a section's stability. Some APIs are so proven and so relied upon that they are unlikely to ever change at all. Others are brand new and experimental, or known to be hazardous.","examples":[],"children":[]},{"kind":"section","id":"stability-overview","name":"Stability overview","title":"Stability overview","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"<DocumentationIndex />","summary":"","examples":[],"children":[]},{"kind":"section","id":"json-output","name":"JSON output","title":"JSON output","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Every `.html` document has a corresponding `.json` document. This is for IDEs\nand other utilities that consume the documentation.","summary":"Every `.html` document has a corresponding `.json` document. This is for IDEs and other utilities that consume the documentation.","examples":[],"children":[]},{"kind":"section","id":"system-calls-and-man-pages","name":"System calls and man pages","title":"System calls and man pages","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"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\nMost Unix system calls have Windows analogues. Still, behavior differences may\nbe unavoidable.","summary":"Node.js functions which wrap a system call will document that. The docs link to the corresponding man pages which describe how the system call works.","examples":[],"children":[]}]}