Acerca de esta documentación
¡Bienvenido a la documentación oficial de referencia de la API para Node.js!
Node.js es un entorno de ejecución de JavaScript construido sobre el motor V8 de JavaScript.
Contribuyendo
Reporte errores en esta documentación en el rastreador de problemas. Consulte la guía de contribución para obtener instrucciones sobre cómo enviar solicitudes de extracción.
Índice de estabilidad
A lo largo de la documentación hay indicaciones de la estabilidad de una sección. Algunas API están tan probadas y se confía tanto en ellas que es poco probable que cambien. Otras son completamente nuevas y experimentales, o se sabe que son peligrosas.
Los índices de estabilidad son los siguientes:
[Estable: 0 - Obsoleto]
Estable: 0 Estabilidad: 0 - Obsoleto. La característica puede emitir advertencias. No se garantiza la compatibilidad con versiones anteriores.
[Estable: 1 - Experimental]
Estable: 1 Estabilidad: 1 - Experimental. La característica no está sujeta a las reglas de versionado semántico. Los cambios no compatibles con versiones anteriores o la eliminación pueden ocurrir en cualquier versión futura. No se recomienda el uso de la característica en entornos de producción.
[Estable: 2 - Estable]
Estable: 2 Estabilidad: 2 - Estable. La compatibilidad con el ecosistema npm es una alta prioridad.
[Estable: 3 - Legado]
Estable: 3 Estabilidad: 3 - Legado. Aunque es poco probable que esta característica se elimine y todavía está cubierta por las garantías de versionado semántico, ya no se mantiene activamente y hay otras alternativas disponibles.
Las características se marcan como heredadas en lugar de obsoletas si su uso no causa daño y se confía ampliamente en ellas dentro del ecosistema npm. Es poco probable que se corrijan los errores encontrados en las características heredadas.
Tenga cuidado al utilizar características experimentales, particularmente al crear bibliotecas. Es posible que los usuarios no sean conscientes de que se están utilizando características experimentales. Los errores o los cambios de comportamiento pueden sorprender a los usuarios cuando se producen modificaciones en la API experimental. Para evitar sorpresas, el uso de una característica experimental puede necesitar un indicador de línea de comandos. Las características experimentales también pueden emitir una advertencia.
Resumen de estabilidad
| API | Estabilidad |
|---|---|
| Assert | (2) Estable |
| Async hooks | (1) Experimental |
| Asynchronous context tracking | (2) Estable |
| Buffer | (2) Estable |
| Child process | (2) Estable |
| Cluster | (2) Estable |
| Console | (2) Estable |
| Crypto | (2) Estable |
| Diagnostics Channel | (2) Estable |
| DNS | (2) Estable |
| Domain | (0) Obsoleto |
| File system | (2) Estable |
| HTTP | (2) Estable |
| HTTP/2 | (2) Estable |
| HTTPS | (2) Estable |
| Inspector | (2) Estable |
Modules: node:module API | (1) .2 - Candidato de lanzamiento (versión asíncrona) Estabilidad: 1.1 - Desarrollo activo (versión síncrona) |
| Modules: CommonJS modules | (2) Estable |
| Modules: TypeScript | (1) .1 - Desarrollo activo |
| OS | (2) Estable |
| Path | (2) Estable |
| Performance measurement APIs | (2) Estable |
| Punycode | (0) Obsoleto |
| Query string | (2) Estable |
| Readline | (2) Estable |
| REPL | (2) Estable |
| Single executable applications | (1) .1 - Desarrollo activo |
| SQLite | (1) .1 - Desarrollo activo. |
| Stream | (2) Estable |
| String decoder | (2) Estable |
| Test runner | (2) Estable |
| Timers | (2) Estable |
| TLS (SSL) | (2) Estable |
| Trace events | (1) Experimental |
| TTY | (2) Estable |
| UDP/datagram sockets | (2) Estable |
| URL | (2) Estable |
| Util | (2) Estable |
| VM (executing JavaScript) | (2) Estable |
| Web Crypto API | (2) Estable |
| Web Streams API | (2) Estable |
| WebAssembly System Interface (WASI) | (1) Experimental |
| Worker threads | (2) Estable |
| Zlib | (2) Estable |
Salida JSON
Añadido en: v0.6.12
Cada documento .html tiene un documento .json correspondiente. Esto es para IDEs y otras utilidades que consumen la documentación.
Llamadas al sistema y páginas de manual
Las funciones de Node.js que encapsulan una llamada al sistema lo documentarán. La documentación enlaza a las páginas de manual correspondientes que describen cómo funciona la llamada al sistema.
La mayoría de las llamadas al sistema Unix tienen análogos en Windows. Aún así, las diferencias de comportamiento pueden ser inevitables.