Sobre esta documentação
Bem-vindo à documentação oficial de referência da API para Node.js!
Node.js é um runtime JavaScript construído no mecanismo 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 confiáveis que é improvável que mudem. Outras são novas e experimentais, ou conhecidas por serem perigosas.
Os índices de estabilidade são os seguintes:
[Estável: 0 - Descontinuado]
Estável: 0 Estabilidade: 0 - Descontinuado. 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 este recurso seja removido e ainda esteja coberto pelas garantias de versionamento semântico, ele não é mais mantido ativamente e outras alternativas estão disponíveis.
Os recursos são marcados como legados em vez de serem descontinuados se seu uso não causar danos e forem amplamente utilizados no ecossistema npm. É improvável que bugs encontrados em recursos legados sejam corrigidos.
Tenha cuidado ao usar recursos experimentais, principalmente 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 modificações experimentais da API ocorrerem. 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 |
| Hooks assíncronos | (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ósticos | (2) Estável |
| DNS | (2) Estável |
| Domain | (0) Descontinuado |
| 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 a 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 |
| Path | (2) Estável |
| APIs de medição de desempenho | (2) Estável |
| Punycode | (0) Descontinuado |
| String de consulta | (2) Estável |
| Readline | (2) Estável |
| REPL | (2) Estável |
| Aplicações executáveis únicas | (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/datagrama | (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 do sistema WebAssembly (WASI) | (1) Experimental |
| Threads de worker | (2) Estável |
| Zlib | (2) Estável |
Saída JSON
Adicionado em: v0.6.12
Cada documento .html tem um documento .json correspondente. Isto é para IDEs e outras utilidades que consomem a documentação.
Chamadas de sistema e páginas de manual
As funções do Node.js que envolvem uma chamada de sistema documentarão isso. Os documentos ligam às páginas de manual 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.