Tabla de Contenidos

• Acerca de esta documentación
  • Índice de estabilidad
  • salida JSON

Acerca de esta documentación#

El objetivo de este documento es explicar íntegralmente la API Node.js, tanto como una referencia, como así también un punto de vista conceptual. Cada sección describe un módulo integrado (built-in module) o un concepto de alto nivel (high-level concept).

En su caso, los tipos de propiedades, los argumentos de métodos, y los argumentos proporcionados a los controladores de eventos se detallan en una lista debajo de la cabecera del topic.

Cada documento .html tiene un documento correspondiente .json presentando la misma información de una manera estructurada. Esta característica es experimental, y se agrega para el beneficio de las IDEs y otras utilidades que desean hacer cosas programáticas con la documentación.

Cada archivo .html y .json es generado en base al correspondiente archivo .markdown de la carpeta doc/api en el árbol del código fuente de node. La documentación es generada utilizando el programa tools/doc/generate.js. La plantilla html esta ubicada en doc/template.html.

Índice de estabilidad#

A lo largo de la documentación verá las indicaciones de estabilidad de cada sección. La API Node.js es algo cambiante, y a medida que madura, ciertas partes son más confiables que otras. Algunas están tan probados, y son tan confiables que es poco probable que cambien en lo absoluto. Otros son completamente nuevos y experimentales, o se considera peligroso y en proceso de ser rediseñado.

Los avisos se parecen a esto:

Stability: 1 Experimental

Los índices de estabilidad son los siguientes:

• 0 - Deprecated Esta característica es conocida como problemática y ya se han previsto cambios. No confíe en esto. El uso de esta característica puede causar advertencias.

• 1 - Experimental Esta característica se ha incluído recientemente y puede cambiar o ser removida en futuras versiones. Por favor, pruébela y de feedback. Si esta dirige a un caso de uso importante para usted, hágalo saber al equipo principal de node.

• 2 - Unstable La API está en proceso de resolución, pero todavia no ha sido suficientemente testeada en el mundo real para ser considerada estable. Si es razonable se mantendrá compatiblidad con versiones anteriores.

• 3 - Stable La API ha resultado satisfactoria pero limpiar en el código subyacente puede causar pequeños cambios. Esta garantizada la compatibilidad con versiones anteriores.

• 4 - API Frozen La API ha sido testeada ampliamente en producción y es poco provable que alguna vez tenga cambios.

• 5 - Locked Al menos que sean encontrados serios bugs este código nunca cambiará. Por favor no sugiera cambios en esta parte, serán rechazados.

salida JSON#

Stability: 1 - Experimental

Cada archivo HTML en el markdown tiene un correspondiente archivo JSON con los mismos datos.

Esta característica se agregó a partir de node v0.6.12. Es experimental.