À propos de cette documentation
Bienvenue dans la documentation de référence officielle de l'API pour Node.js !
Node.js est un environnement d'exécution JavaScript construit sur le moteur JavaScript V8.
Contribution
Signalez les erreurs dans cette documentation dans l'outil de suivi des problèmes. Consultez le guide de contribution pour savoir comment soumettre des requêtes d'extraction.
Indice de stabilité
Tout au long de la documentation, des indications de la stabilité d'une section sont fournies. Certaines API sont si éprouvées et si fiables qu'il est peu probable qu'elles changent un jour. D'autres sont toutes nouvelles et expérimentales, ou reconnues comme dangereuses.
Les indices de stabilité sont les suivants :
[Stable : 0 - Déprécié]
Stable : 0 Stabilité : 0 - Déprécié. La fonctionnalité peut émettre des avertissements. La compatibilité ascendante n'est pas garantie.
[Stable : 1 - Expérimental]
Stable : 1 Stabilité : 1 - Expérimental. La fonctionnalité n'est pas soumise aux règles de versionnage sémantique. Des changements incompatibles avec les versions antérieures ou une suppression peuvent se produire dans toute version future. L'utilisation de la fonctionnalité n'est pas recommandée dans les environnements de production.
[Stable : 2 - Stable]
Stable : 2 Stabilité : 2 - Stable. La compatibilité avec l'écosystème npm est une priorité élevée.
[Stable : 3 - Hérité]
Stable : 3 Stabilité : 3 - Hérité. Bien qu'il soit peu probable que cette fonctionnalité soit supprimée et qu'elle soit toujours couverte par les garanties de versionnage sémantique, elle n'est plus activement maintenue, et d'autres alternatives sont disponibles.
Les fonctionnalités sont marquées comme héritées plutôt que comme dépréciées si leur utilisation ne cause aucun dommage et si elles sont largement utilisées dans l'écosystème npm. Il est peu probable que les bogues trouvés dans les fonctionnalités héritées soient corrigés.
Soyez prudent lorsque vous utilisez des fonctionnalités expérimentales, en particulier lors de la création de bibliothèques. Les utilisateurs peuvent ne pas être conscients de l'utilisation de fonctionnalités expérimentales. Les bogues ou les changements de comportement peuvent surprendre les utilisateurs lorsque des modifications de l'API expérimentale se produisent. Pour éviter les surprises, l'utilisation d'une fonctionnalité expérimentale peut nécessiter un indicateur de ligne de commande. Les fonctionnalités expérimentales peuvent également émettre un avertissement.
Aperçu de la stabilité
| API | Stabilité |
|---|---|
| Assert | (2) Stable |
| Hooks Async | (1) Expérimental |
| Suivi du contexte asynchrone | (2) Stable |
| Buffer | (2) Stable |
| Processus enfant | (2) Stable |
| Cluster | (2) Stable |
| Console | (2) Stable |
| Crypto | (2) Stable |
| Canal de diagnostics | (2) Stable |
| DNS | (2) Stable |
| Domaine | (0) Déprécié |
| Système de fichiers | (2) Stable |
| HTTP | (2) Stable |
| HTTP/2 | (2) Stable |
| HTTPS | (2) Stable |
| Inspecteur | (2) Stable |
Modules: API node:module | (1) .2 - Release candidate (version asynchrone) Stabilité : 1.1 - Développement actif (version synchrone) |
| Modules : modules CommonJS | (2) Stable |
| Modules : TypeScript | (1) .1 - Développement actif |
| OS | (2) Stable |
| Path | (2) Stable |
| API de mesure des performances | (2) Stable |
| Punycode | (0) Déprécié |
| Chaîne de requête | (2) Stable |
| Readline | (2) Stable |
| REPL | (2) Stable |
| Applications exécutables uniques | (1) .1 - Développement actif |
| SQLite | (1) .1 - Développement actif. |
| Stream | (2) Stable |
| Décodeur de chaîne | (2) Stable |
| Test runner | (2) Stable |
| Minuteurs | (2) Stable |
| TLS (SSL) | (2) Stable |
| Événements de trace | (1) Expérimental |
| TTY | (2) Stable |
| Sockets UDP/datagramme | (2) Stable |
| URL | (2) Stable |
| Util | (2) Stable |
| VM (exécution de JavaScript) | (2) Stable |
| API Web Crypto | (2) Stable |
| API Web Streams | (2) Stable |
| Interface du système WebAssembly (WASI) | (1) Expérimental |
| Threads de Worker | (2) Stable |
| Zlib | (2) Stable |
Sortie JSON
Ajouté dans: v0.6.12
Chaque document .html a un document .json correspondant. Ceci est destiné aux IDE et autres utilitaires qui consomment la documentation.
Appels système et pages de manuel
Les fonctions Node.js qui encapsulent un appel système le documenteront. La documentation renvoie aux pages de manuel correspondantes qui décrivent le fonctionnement de l'appel système.
La plupart des appels système Unix ont des équivalents Windows. Néanmoins, des différences de comportement peuvent être inévitables.