Über diese Dokumentation
Willkommen bei der offiziellen API-Referenzdokumentation für Node.js!
Node.js ist eine JavaScript-Laufzeitumgebung, die auf der V8 JavaScript-Engine basiert.
Mitwirken
Melden Sie Fehler in dieser Dokumentation im Issue-Tracker. Anweisungen zum Einreichen von Pull-Requests finden Sie in der Anleitung zum Mitwirken.
Stabilitätsindex
Die Dokumentation enthält Hinweise auf die Stabilität eines Abschnitts. Einige APIs sind so bewährte und werden so stark genutzt, dass sie sich wahrscheinlich überhaupt nicht ändern werden. Andere sind brandneu und experimentell oder als gefährlich bekannt.
Die Stabilitätsindizes sind wie folgt:
[Stabil: 0 - Veraltet]
Stabil: 0 Stabilität: 0 - Veraltet. Das Feature kann Warnungen ausgeben. Abwärtskompatibilität ist nicht garantiert.
[Stabil: 1 - Experimentell]
Stabil: 1 Stabilität: 1 - Experimentell. Das Feature unterliegt nicht den Regeln der semantischen Versionierung. Nicht abwärtskompatible Änderungen oder die Entfernung können in zukünftigen Releases auftreten. Die Verwendung des Features wird in Produktionsumgebungen nicht empfohlen.
[Stabil: 2 - Stabil]
Stabil: 2 Stabilität: 2 - Stabil. Die Kompatibilität mit dem npm-Ökosystem hat hohe Priorität.
[Stabil: 3 - Legacy]
Stabil: 3 Stabilität: 3 - Legacy. Obwohl dieses Feature wahrscheinlich nicht entfernt wird und weiterhin von semantischen Versionsgarantien abgedeckt ist, wird es nicht mehr aktiv gewartet, und es sind andere Alternativen verfügbar.
Features werden eher als Legacy gekennzeichnet als als veraltet, wenn ihre Verwendung keinen Schaden anrichtet und sie im npm-Ökosystem weit verbreitet sind. Fehler, die in Legacy-Features gefunden werden, werden wahrscheinlich nicht behoben.
Seien Sie vorsichtig bei der Verwendung experimenteller Features, insbesondere beim Erstellen von Bibliotheken. Benutzer sind sich möglicherweise nicht bewusst, dass experimentelle Features verwendet werden. Fehler oder Verhaltensänderungen können Benutzer überraschen, wenn Änderungen an experimentellen APIs auftreten. Um Überraschungen zu vermeiden, kann die Verwendung eines experimentellen Features ein Befehlszeilenflag erfordern. Experimentelle Features können auch eine Warnung ausgeben.
Stabilitätsübersicht
| API | Stabilität |
|---|---|
| Assert | (2) Stabil |
| Async hooks | (1) Experimentell |
| Asynchrone Kontextverfolgung | (2) Stabil |
| Buffer | (2) Stabil |
| Child process | (2) Stabil |
| Cluster | (2) Stabil |
| Console | (2) Stabil |
| Crypto | (2) Stabil |
| Diagnostics Channel | (2) Stabil |
| DNS | (2) Stabil |
| Domain | (0) Veraltet |
| Dateisystem | (2) Stabil |
| HTTP | (2) Stabil |
| HTTP/2 | (2) Stabil |
| HTTPS | (2) Stabil |
| Inspector | (2) Stabil |
Module: node:module API | (1) .2 - Release Candidate (asynchrone Version) Stabilität: 1.1 - Aktive Entwicklung (synchrone Version) |
| Module: CommonJS Module | (2) Stabil |
| Module: TypeScript | (1) .1 - Aktive Entwicklung |
| OS | (2) Stabil |
| Path | (2) Stabil |
| APIs zur Leistungsbeurteilung | (2) Stabil |
| Punycode | (0) Veraltet |
| Query String | (2) Stabil |
| Readline | (2) Stabil |
| REPL | (2) Stabil |
| Standalone-Anwendungen | (1) .1 - Aktive Entwicklung |
| SQLite | (1) .1 - Aktive Entwicklung. |
| Stream | (2) Stabil |
| String Decoder | (2) Stabil |
| Test Runner | (2) Stabil |
| Timer | (2) Stabil |
| TLS (SSL) | (2) Stabil |
| Trace Events | (1) Experimentell |
| TTY | (2) Stabil |
| UDP/Datagram Sockets | (2) Stabil |
| URL | (2) Stabil |
| Util | (2) Stabil |
| VM (JavaScript-Ausführung) | (2) Stabil |
| Web Crypto API | (2) Stabil |
| Web Streams API | (2) Stabil |
| WebAssembly System Interface (WASI) | (1) Experimentell |
| Worker Threads | (2) Stabil |
| Zlib | (2) Stabil |
JSON-Ausgabe
Hinzugefügt in: v0.6.12
Jedes .html-Dokument hat ein entsprechendes .json-Dokument. Dies ist für IDEs und andere Dienstprogramme gedacht, die die Dokumentation verarbeiten.
Systemaufrufe und Manpages
Node.js-Funktionen, die einen Systemaufruf kapseln, werden dies dokumentieren. Die Dokumentation verlinkt auf die entsprechenden Manpages, die beschreiben, wie der Systemaufruf funktioniert.
Die meisten Unix-Systemaufrufe haben Windows-Analoga. Dennoch können Verhaltensunterschiede unvermeidlich sein.