Перейти к содержанию

API Node.js

Цель написания этой документации состоит в том, чтобы всесторонне объяснить Node.js API как с общепринятой, так и с концептуальной точки зрения. Каждый раздел описывает встроенный модуль или высокоуровневый концепт.

В некоторых случаях типы переменных, параметры методов и параметры, относящиеся к обработке событий, детально описаны по ссылкам под заголовком темы.

Индекс стабильности

В этой документации вы можете увидеть показатели стабильности раздела. Node.js API до сих пор изменяется и обрастает новыми улучшениями, по этой причине некоторые части этой документации являются менее стабильными, чем другие. Основополагающие принципы АПИ вряд ли подвергнутся изменениям. Другие могут быть новыми или экспериментальными, или же вовсе небезопасными и находящимися в процессе редизайна.

Индексы стабильности представлены следующими:

Стабильность: 0 – устарело или набрало много негативных отзывов

Эта фича является проблемной и ее планируют изменить. Не стоит полагаться на нее. Использование фичи может вызвать ошибки. Не стоит ожидать от нее обратной совместимости.

Стабильность: 1 – Экспериментальная

Фича изменяется и не допускается флагом командной строки. Может быть изменена или удалена в последующих версиях.

Стабильность: 2 – Стабильная

АПИ является удовлетворительным. Совместимость с NPM имеет высший приоритет и не будет нарушена кроме случаев явной необходимости.

Стабильность: 3 – Закрыто

Принимаются только фиксы, связанные с безопасностью, производительностью или баг-фиксы. Пожалуйста, не предлагайте изменений АПИ в разделе с таким индикатором, они будут отклонены.

Краткий обзор

node [options] [v8 options] [script.js | -e "script"] [arguments]

Пример веб-сервера, написанного на Node.js, который отвечает “Hello World”:

const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(
    `Сервер запущен на http://${hostname}:${port}/`
  );
});

Чтобы запустить сервер, поместите код в файл под названием example.js и запустите с помощью node.

$ node example.js  (Знак $ - является директорией в которой расположен файл example.js)

Сервер запущен на http://${hostname}:${port}/

Все примеры из документации могут быть запущены аналогичным способом.