Acerca de esta documentación
¡Bienvenido a la documentación de referencia de la API oficial de Node.js!
Node.js es un entorno de ejecución de JavaScript basado en el motor JavaScript V8.
Contribución
Informe 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
En toda la documentación hay indicaciones de la estabilidad de una sección. Algunas API están tan probadas y son tan confiables que es poco probable que cambien alguna vez. 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 función puede emitir advertencias. La compatibilidad con versiones anteriores no está garantizada.
[Estable: 1 - Experimental]
Estable: 1 Estabilidad: 1 - Experimental. La función no está sujeta a las reglas de control de versiones semánticas. 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 función 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 - Heredado]
Estable: 3 Estabilidad: 3 - Heredado. Aunque es poco probable que esta función se elimine y todavía está cubierta por las garantías de control de versiones semánticas, ya no se mantiene activamente y hay otras alternativas disponibles.
Las funciones se marcan como heredadas en lugar de obsoletas si su uso no causa daño y son ampliamente utilizadas en el ecosistema npm. Es poco probable que se corrijan los errores encontrados en las funciones heredadas.
Tenga precaución al utilizar funciones experimentales, especialmente al crear bibliotecas. Los usuarios pueden no ser conscientes de que se están utilizando funciones 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 función experimental puede necesitar un indicador de línea de comandos. Las funciones experimentales también pueden emitir una advertencia.
Resumen de estabilidad
| API | Estabilidad |
|---|---|
| Assert | (2) Estable |
| Ganchos asincrónicos | (1) Experimental |
| Seguimiento de contexto asincrónico | (2) Estable |
| Buffer | (2) Estable |
| Proceso secundario | (2) Estable |
| Clúster | (2) Estable |
| Consola | (2) Estable |
| Criptografía | (2) Estable |
| Canal de diagnósticos | (2) Estable |
| DNS | (2) Estable |
| Dominio | (0) Obsoleto |
| Sistema de archivos | (2) Estable |
| HTTP | (2) Estable |
| HTTP/2 | (2) Estable |
| HTTPS | (2) Estable |
| Inspector | (2) Estable |
Módulos: API node:module | (1) .2 - Candidato a lanzamiento (versión asíncrona) Estabilidad: 1.1 - Desarrollo activo (versión síncrona) |
| Módulos: Módulos CommonJS | (2) Estable |
| Módulos: TypeScript | (1) .1 - Desarrollo activo |
| OS | (2) Estable |
| Ruta | (2) Estable |
| APIs de medición de rendimiento | (2) Estable |
| Punycode | (0) Obsoleto |
| Cadena de consulta | (2) Estable |
| Readline | (2) Estable |
| REPL | (2) Estable |
| Aplicaciones ejecutables únicas | (1) .1 - Desarrollo activo |
| SQLite | (1) .1 - Desarrollo activo. |
| Flujo | (2) Estable |
| Decodificador de cadenas | (2) Estable |
| Ejecutor de pruebas | (2) Estable |
| Temporizadores | (2) Estable |
| TLS (SSL) | (2) Estable |
| Eventos de seguimiento | (1) Experimental |
| TTY | (2) Estable |
| Sockets UDP/datagrama | (2) Estable |
| URL | (2) Estable |
| Util | (2) Estable |
| VM (ejecutando JavaScript) | (2) Estable |
| API Web Crypto | (2) Estable |
| API Web Streams | (2) Estable |
| Interfaz del sistema WebAssembly (WASI) | (1) Experimental |
| Hilos de trabajo | (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 man
Las funciones de Node.js que encapsulan una llamada al sistema la documentarán. La documentación enlaza con las páginas man 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.