Об этой документации
Добро пожаловать в официальную справочную документацию по API Node.js!
Node.js — это среда выполнения JavaScript, построенная на движке JavaScript V8.
Вклад
Сообщайте об ошибках в этой документации в трекере проблем. Смотрите руководство для участников для получения инструкций о том, как отправлять запросы на включение изменений.
Индекс стабильности
В документации есть указания на стабильность раздела. Некоторые API настолько проверены и настолько надежны, что маловероятно, что они когда-либо изменятся. Другие совершенно новые и экспериментальные или известны как опасные.
Индексы стабильности следующие:
[Стабильность: 0 - Устаревший]
Стабильность: 0 Стабильность: 0 - Устаревший. Эта функция может выдавать предупреждения. Обратная совместимость не гарантируется.
[Стабильность: 1 - Экспериментальный]
Стабильность: 1 Стабильность: 1 - Экспериментальный. Эта функция не подпадает под действие правил семантического версионирования. Несовместимые с обратной совместимостью изменения или удаление могут произойти в любом будущем выпуске. Использовать эту функцию в производственной среде не рекомендуется.
[Стабильность: 2 - Стабильный]
Стабильность: 2 Стабильность: 2 - Стабильный. Совместимость с экосистемой npm является высоким приоритетом.
[Стабильность: 3 - Устаревшее]
Стабильность: 3 Стабильность: 3 - Устаревшее. Хотя эта функция вряд ли будет удалена и по-прежнему подпадает под гарантии семантического версионирования, она больше не поддерживается активно, и доступны другие альтернативы.
Функции помечаются как устаревшие, а не как устаревшие, если их использование не причиняет вреда и на них широко полагаются в экосистеме npm. Ошибки, найденные в устаревших функциях, вряд ли будут исправлены.
Будьте осторожны при использовании экспериментальных функций, особенно при создании библиотек. Пользователи могут не знать, что используются экспериментальные функции. Ошибки или изменения в поведении могут удивить пользователей при внесении изменений в экспериментальный API. Чтобы избежать сюрпризов, для использования экспериментальной функции может потребоваться флаг командной строки. Экспериментальные функции также могут выдавать предупреждение.
Обзор стабильности
| API | Стабильность |
|---|---|
| Assert | (2) Стабильно |
| Async hooks | (1) Экспериментально |
| Asynchronous context tracking | (2) Стабильно |
| Buffer | (2) Стабильно |
| Child process | (2) Стабильно |
| Cluster | (2) Стабильно |
| Console | (2) Стабильно |
| Crypto | (2) Стабильно |
| Diagnostics Channel | (2) Стабильно |
| DNS | (2) Стабильно |
| Domain | (0) Устарело |
| File system | (2) Стабильно |
| HTTP | (2) Стабильно |
| HTTP/2 | (2) Стабильно |
| HTTPS | (2) Стабильно |
| Inspector | (2) Стабильно |
Modules: node:module API | (1) .2 - Кандидат на релиз (асинхронная версия) Стабильность: 1.1 - Активная разработка (синхронная версия) |
| Modules: CommonJS modules | (2) Стабильно |
| Modules: TypeScript | (1) .1 - Активная разработка |
| OS | (2) Стабильно |
| Path | (2) Стабильно |
| Performance measurement APIs | (2) Стабильно |
| Punycode | (0) Устарело |
| Query string | (2) Стабильно |
| Readline | (2) Стабильно |
| REPL | (2) Стабильно |
| Single executable applications | (1) .1 - Активная разработка |
| SQLite | (1) .1 - Активная разработка. |
| Stream | (2) Стабильно |
| String decoder | (2) Стабильно |
| Test runner | (2) Стабильно |
| Timers | (2) Стабильно |
| TLS (SSL) | (2) Стабильно |
| Trace events | (1) Экспериментально |
| TTY | (2) Стабильно |
| UDP/datagram sockets | (2) Стабильно |
| URL | (2) Стабильно |
| Util | (2) Стабильно |
| VM (executing JavaScript) | (2) Стабильно |
| Web Crypto API | (2) Стабильно |
| Web Streams API | (2) Стабильно |
| WebAssembly System Interface (WASI) | (1) Экспериментально |
| Worker threads | (2) Стабильно |
| Zlib | (2) Стабильно |
JSON output
Добавлено в: v0.6.12
Каждый документ .html имеет соответствующий документ .json. Это предназначено для IDE и других утилит, использующих документацию.
Системные вызовы и man pages
Функции Node.js, которые оборачивают системный вызов, будут это документировать. Документы ссылаются на соответствующие man pages, которые описывают, как работает системный вызов.
Большинство системных вызовов Unix имеют аналоги в Windows. Тем не менее, различий в поведении может быть невозможно избежать.