Sobre esta documentação
Bem-vindo à documentação oficial de referência da API para o Node.js!
O Node.js é um tempo de execução JavaScript construído sobre o motor JavaScript V8.
Contribuindo
Reporte erros nesta documentação no rastreador de problemas. Consulte o guia de contribuição para obter instruções sobre como enviar pull requests.
Índice de estabilidade
Ao longo da documentação, há indicações da estabilidade de uma seção. Algumas APIs são tão comprovadas e tão confiáveis que é improvável que alguma vez mudem. Outras são novas e experimentais, ou conhecidas por serem perigosas.
Os índices de estabilidade são os seguintes:
[Estável: 0 - Obsoleto]
Estável: 0 Estabilidade: 0 - Obsoleto. O recurso pode emitir avisos. A compatibilidade com versões anteriores não é garantida.
[Estável: 1 - Experimental]
Estável: 1 Estabilidade: 1 - Experimental. O recurso não está sujeito às regras de versionamento semântico. Alterações não compatíveis com versões anteriores ou remoção podem ocorrer em qualquer versão futura. O uso do recurso não é recomendado em ambientes de produção.
[Estável: 2 - Estável]
Estável: 2 Estabilidade: 2 - Estável. A compatibilidade com o ecossistema npm é uma alta prioridade.
[Estável: 3 - Legado]
Estável: 3 Estabilidade: 3 - Legado. Embora seja improvável que esse recurso seja removido e ainda esteja coberto pelas garantias de versionamento semântico, ele não está mais sendo mantido ativamente e outras alternativas estão disponíveis.
Os recursos são marcados como legado em vez de serem obsoletos se seu uso não causar danos e se forem amplamente utilizados no ecossistema npm. É improvável que os bugs encontrados em recursos legados sejam corrigidos.
Tenha cuidado ao usar recursos experimentais, especialmente ao criar bibliotecas. Os usuários podem não estar cientes de que recursos experimentais estão sendo usados. Bugs ou mudanças de comportamento podem surpreender os usuários quando ocorrerem modificações na API experimental. Para evitar surpresas, o uso de um recurso experimental pode precisar de um sinalizador de linha de comando. Recursos experimentais também podem emitir um aviso.
Visão geral da estabilidade
| API | Estabilidade |
|---|---|
| Assert | (2) Estável |
| Async hooks | (1) Experimental |
| Rastreamento de contexto assíncrono | (2) Estável |
| Buffer | (2) Estável |
| Processo filho | (2) Estável |
| Cluster | (2) Estável |
| Console | (2) Estável |
| Crypto | (2) Estável |
| Canal de Diagnóstico | (2) Estável |
| DNS | (2) Estável |
| Domínio | (0) Obsoleto |
| Sistema de arquivos | (2) Estável |
| HTTP | (2) Estável |
| HTTP/2 | (2) Estável |
| HTTPS | (2) Estável |
| Inspector | (2) Estável |
Módulos: API node:module | (1) .2 - Candidato ao lançamento (versão assíncrona) Estabilidade: 1.1 - Desenvolvimento ativo (versão síncrona) |
| Módulos: módulos CommonJS | (2) Estável |
| Módulos: TypeScript | (1) .1 - Desenvolvimento ativo |
| SO | (2) Estável |
| Caminho | (2) Estável |
| APIs de medição de desempenho | (2) Estável |
| Punycode | (0) Obsoleto |
| String de consulta | (2) Estável |
| Readline | (2) Estável |
| REPL | (2) Estável |
| Aplicativos executáveis únicos | (1) .1 - Desenvolvimento ativo |
| SQLite | (1) .1 - Desenvolvimento ativo. |
| Stream | (2) Estável |
| Decodificador de string | (2) Estável |
| Executador de testes | (2) Estável |
| Timers | (2) Estável |
| TLS (SSL) | (2) Estável |
| Eventos de rastreamento | (1) Experimental |
| TTY | (2) Estável |
| Sockets UDP/datagram | (2) Estável |
| URL | (2) Estável |
| Util | (2) Estável |
| VM (executando JavaScript) | (2) Estável |
| API Web Crypto | (2) Estável |
| API Web Streams | (2) Estável |
| Interface de sistema WebAssembly (WASI) | (1) Experimental |
| Threads de worker | (2) Estável |
| Zlib | (2) Estável |
Saída JSON
Adicionado em: v0.6.12
Todo documento .html tem um documento .json correspondente. Isso é para IDEs e outras utilidades que consomem a documentação.
Chamadas de sistema e páginas man
Funções do Node.js que envolvem uma chamada de sistema irão documentar isso. Os documentos têm links para as páginas man correspondentes que descrevem como a chamada de sistema funciona.
A maioria das chamadas de sistema Unix têm análogos no Windows. Ainda assim, diferenças de comportamento podem ser inevitáveis.