Über diese Dokumentation
Willkommen zur 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. Im Leitfaden für Mitwirkende finden Sie Anweisungen zum Einreichen von Pull Requests.
Stabilitätsindex
In der gesamten Dokumentation gibt es Hinweise auf die Stabilität eines Abschnitts. Einige APIs sind so bewährt und werden so stark genutzt, dass es unwahrscheinlich ist, dass sie sich jemals ä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. Die 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 Entfernungen können in zukünftigen Versionen auftreten. Die Verwendung des Features in Produktionsumgebungen wird 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 durch semantische Versionsgarantien abgedeckt ist, wird es nicht mehr aktiv gewartet, und es sind andere Alternativen verfügbar.
Funktionen werden als Legacy und nicht als veraltet gekennzeichnet, wenn ihre Verwendung keinen Schaden anrichtet und sie im npm-Ökosystem weit verbreitet sind. Fehler, die in Legacy-Funktionen gefunden werden, werden wahrscheinlich nicht behoben.
Seien Sie vorsichtig, wenn Sie experimentelle Funktionen verwenden, insbesondere wenn Sie Bibliotheken erstellen. Benutzer sind sich möglicherweise nicht bewusst, dass experimentelle Funktionen verwendet werden. Fehler oder Verhaltensänderungen können Benutzer überraschen, wenn experimentelle API-Änderungen auftreten. Um Überraschungen zu vermeiden, benötigt die Verwendung einer experimentellen Funktion möglicherweise ein Befehlszeilen-Flag. Experimentelle Funktionen können auch eine Warnung ausgeben.
Stabilitätsübersicht
| API | Stabilität |
|---|---|
| Assert | (2) Stabil |
| Asynchrone Hooks | (1) Experimentell |
| Asynchrone Kontextverfolgung | (2) Stabil |
| Buffer | (2) Stabil |
| Kindprozess | (2) Stabil |
| Cluster | (2) Stabil |
| Konsole | (2) Stabil |
| Krypto | (2) Stabil |
| Diagnosekanal | (2) Stabil |
| DNS | (2) Stabil |
| Domain | (0) Veraltet |
| Dateisystem | (2) Stabil |
| HTTP | (2) Stabil |
| HTTP/2 | (2) Stabil |
| HTTPS | (2) Stabil |
| Inspektor | (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 |
| Pfad | (2) Stabil |
| APIs zur Leistungsmessung | (2) Stabil |
| Punycode | (0) Veraltet |
| Query-String | (2) Stabil |
| Readline | (2) Stabil |
| REPL | (2) Stabil |
| Einzelne ausführbare 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ühren) | (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, die die Dokumentation nutzen.
Systemaufrufe und Manpages
Node.js-Funktionen, die einen Systemaufruf umschließen, dokumentieren dies. Die Dokumente verlinken auf die entsprechenden Manpages, die beschreiben, wie der Systemaufruf funktioniert.
Die meisten Unix-Systemaufrufe haben Windows-Analoga. Dennoch können Verhaltensunterschiede unvermeidlich sein.