Об этой документации¶
Добро пожаловать в официальную справочную документацию по API Node.js.
Node.js - это среда выполнения JavaScript, построенная на движке V8 JavaScript.
Участие в разработке¶
Сообщайте об ошибках в этой документации через трекер задач. Инструкции по отправке pull request см. в руководстве по участию в разработке.
Индекс стабильности¶
В документации используются обозначения стабильности разделов. Некоторые API настолько проверены временем и настолько широко используются, что вряд ли когда-либо существенно изменятся. Другие появились совсем недавно и остаются экспериментальными, либо известны как потенциально рискованные.
Индексы стабильности используются следующие:
Стабильность: 0 – устарело
Возможность может выводить предупреждения. Обратная совместимость не гарантируется.
Стабильность: 1 – Экспериментальная
Эта возможность не подпадает под правила семантического версионирования. Несовместимые назад изменения или удаление могут произойти в любом будущем релизе. Использовать такую возможность в production-окружении не рекомендуется.
Экспериментальные возможности дополнительно делятся на стадии:
1.0- ранняя разработка. Возможность ещё не завершена и может существенно измениться.1.1- активная разработка. Возможность приближается к минимально жизнеспособному состоянию.1.2- кандидат в релиз. Ожидается, что возможность почти готова стать стабильной. Дополнительные ломающие изменения не предполагаются, но всё ещё возможны в ответ на отзывы пользователей или развитие базовой спецификации. Пользовательское тестирование и обратная связь помогают понять, готова ли эта возможность к переходу в стабильный статус.
Экспериментальные возможности обычно либо переходят в стабильный статус, либо удаляются без цикла устаревания.
Стабильность: 2 – Стабильная
Совместимость с экосистемой npm имеет высокий приоритет.
Стабильность: 3 – Устаревшая, но поддерживаемая
Хотя эту возможность вряд ли удалят и на неё по-прежнему распространяются гарантии семантического версионирования, она больше не развивается активно, и для неё существуют альтернативы.
Возможности помечаются как legacy, а не как deprecated, если их использование не наносит вреда и они широко применяются в экосистеме npm. Ошибки, найденные в legacy-возможностях, с высокой вероятностью исправляться не будут.
Используйте экспериментальные возможности с осторожностью, особенно при разработке библиотек. Пользователи могут не знать, что библиотека опирается на экспериментальный API. Изменения поведения или ошибки способны неожиданно затронуть пользователей, когда такой API меняется. Чтобы избежать сюрпризов, для использования экспериментальной возможности может потребоваться флаг командной строки. Экспериментальные возможности также могут выводить предупреждение.
Обзор стабильности¶
Вывод в JSON¶
У каждого документа .html есть соответствующий документ .json. Он предназначен для IDE и других инструментов, которые потребляют эту документацию.
Системные вызовы и man-страницы¶
Функции Node.js, которые оборачивают системный вызов, отмечают это в документации. Ссылки в документации ведут на соответствующие man-страницы, где описано поведение системного вызова.
У большинства системных вызовов Unix есть аналоги в Windows. Тем не менее различия в поведении не всегда можно устранить.