Node js обработка ошибок - Исправление ошибок и поиск оптимальных решений проблем

Ошибки есть в каждом коде. Мы перевели гайд разработчика Айо Исайя, в котором он рассказывает о системе ошибок и о том, как их устранять.

Раз вы читаете эту статью, вы, конечно, знакомы с концепцией ошибок в программировании. Это ошибки в коде, они же баги, которые приводят к сбою или неожиданному поведению программы. В отличие от некоторых языков, таких как Go и Rust, где вы вынуждены взаимодействовать с потенциальными ошибками на каждом этапе пути, в JavaScript и Node.js можно обойтись без согласованной стратегии обработки ошибок.

Однако именно такая стратегия делает жизнь проще. Цель статьи — познакомить вас с этими шаблонами для создания, доставки и обработки потенциальных ошибок. Шаблоны помогут обнаружить и обработать потенциальные ошибки в коде до развёртывания.

Что такое ошибки в Node.js

Ошибка в Node.js — это любой экземпляр объекта Error. Общие примеры включают встроенные классы ошибок: ReferenceError, RangeError, TypeError, URIError, EvalError и SyntaxError. Пользовательские ошибки также можно создать путём расширения базового объекта Error, встроенного класса ошибки или другой настраиваемой ошибки. При создании ошибок таким путём нужно передать строку сообщения, описывающую ошибку. К сообщению можно получить доступ через свойство message объекта. Объект Error также содержит свойства name и stack, которые указывают имя ошибки и точку в коде, в которой объект создаётся.

const userError = new TypeError("Something happened!");
console.log(userError.name); // TypeError
console.log(userError.message); // Something happened!
console.log(userError.stack);
/*TypeError: Something happened!
    at Object.<anonymous> (/home/ayo/dev/demo/main.js:2:19)
    <truncated for brevity>
    at node:internal/main/run_main_module:17:47 */

Функции объекта Error можно передать или вернуть из функции. Если бросить его с помощью throw, объект Error станет исключением. Когда вы передаёте ошибку из функции, она переходит вверх по стеку, пока исключение не будет поймано. В противном случае uncaught exception может обвалить всю работу.

Как обработать ошибку

Оптимальный способ обработки ошибок функции JavaScript зависит от того, выполняет ли эта функция синхронную или асинхронную операцию. Рассмотрим четыре общих шаблона, позволяющих обрабатывать ошибки функций в Node.js.

Исключения

Чаще всего ошибки функций обрабатывают путём генерации. В этом случае ошибка становится исключением, после чего её можно поймать где-нибудь в стеке с помощью блока try / catch. Если у ошибки есть разрешение всплывать в стеке, не будучи перехваченной, она преобразуется в формат uncaughtException, что приводит к преждевременному завершению работы приложения. Например, встроенный метод JSON.parse () выдаёт ошибку, если строковый аргумент не является допустимым объектом JSON.

function parseJSON(data) {
  return JSON.parse(data);
}
try {
  const result = parseJSON('A string');
} catch (err) {
  console.log(err.message); // Unexpected token A in JSON at position 0
}

Для использования этого шаблона в функциях нужно добавить ключевое слово throw перед экземпляром ошибки. Этот шаблон сообщения об ошибках и обработки идиоматичен для функций, выполняющих синхронные операции.

function square(num) {
  if (typeof num !== 'number') {
    throw new TypeError(`Expected number but got: ${typeof num}`);
  }
  return num * num;
}
try {
  square('8');
} catch (err) {
  console.log(err.message); // Expected number but got: string
}

Колбэк с первым аргументом-ошибкой

Из-за своей асинхронной природы Node.js интенсивно использует функции колбэка для обработки большей части ошибок. Колбэк (обратный вызов) передаётся в качестве аргумента другой функции и выполняется, когда последняя завершает свою работу.

Node.js использует колбэк с первым аргументом-ошибкой в большинстве асинхронных методов, чтобы гарантировать проверку ошибок до результатов операции. Колбэк обычно является последним аргументом функции, инициирующей асинхронную операцию, и вызывается один раз при возникновении ошибки или получении результата:

function (err, result) {}

Первый аргумент зарезервирован для объекта ошибки. Если ошибка возникает в ходе асинхронной операции, она доступна через аргумент err при неопределённом результате. Однако, если ошибки не возникает, err будет иметь значение null или undefined, а result будет содержать ожидаемый результат операции. Этот шаблон работает, если прочитать содержимое файла с помощью встроенного метода fs.readFile ():

const fs = require('fs');
fs.readFile('/path/to/file.txt', (err, result) => {
  if (err) {
    console.error(err);
    return;
  }
  // Log the file contents if no error
  console.log(result);
});

Метод readFile () использует колбэк в качестве своего последнего аргумента, который, в свою очередь, соответствует подписи функции «первая ошибка». В этом сценарии result включает в себя содержимое файла, который читается, если ошибки не возникает. В противном случае он определяется как undefined, а аргумент err заполняется объектом ошибки, содержащим информацию о проблеме: файл не найден или недостаточно полномочий.

Как правило, методы, использующие колбэк для обработки ошибок, не могут определить, насколько важна выявленная ошибка. Они возвращают ошибку пользователю для обработки. Важно контролировать поток содержимого колбэка, проверять функцию на наличие ошибки, прежде чем пытаться получить доступ к результату операции.

Чтобы использовать шаблон колбэка с первым аргументом-ошибкой в собственных асинхронных функциях, нужно принять функцию в качестве последнего аргумента и вызвать её:

function square(num, callback) {
  if (typeof callback !== 'function') {
    throw new TypeError(`Callback must be a function. Got: ${typeof callback}`);
  }
  // simulate async operation
  setTimeout(() => {
    if (typeof num !== 'number') {
      // if an error occurs, it is passed as the first argument to the callback
      callback(new TypeError(`Expected number but got: ${typeof num}`));
      return;
    }
    const result = num * num;
    // callback is invoked after the operation completes with the result
    callback(null, result);
  }, 100);
}

Любой вызывающий функцию square должен пройти через колбэк, чтобы получить доступ к нужному результату или ошибке.

Не нужно непосредственно обрабатывать ошибку в функции колбэка. Её можно распространить вверх по стеку, передав на другой колбэк. Но сначала убедитесь, что вы не генерируете исключение внутри функции. Асинхронное исключение невозможно отследить, потому что окружающий блок try / catch завершается до выполнения колбэка. Следовательно, исключение будет распространяться на вершину стека, что приведёт к завершению работы приложения. Исключение — когда обработчик зарегистрирован для process.on ('uncaughtException').

try {
  square('8', (err, result) => {
    if (err) {
      throw err; // not recommended
    }
    console.log(result);
  });
} catch (err) {
  // This won't work
  console.error("Caught error: ", err);
}

Отклонение обещаний

Обещания в JavaScript — это актуальный способ выполнения асинхронных операций в Node.js. Они предпочтительнее колбэков из-за лучшего потока, который соответствует современным способам анализа программ, особенно с шаблоном async / await. Любой API-интерфейс Node.js, использующий колбэки с ошибкой для асинхронной обработки ошибок, может быть преобразован в обещания с помощью встроенного метода util.promisify (). Например, заставить метод fs.readFile () использовать обещания можно так:

const fs = require('fs');
const util = require('util');
const readFile = util.promisify(fs.readFile);

Переменная readFile — это версия fs.readFile () с обещаниями, в которой отклонения обещаний используются для сообщения об ошибках. Эти ошибки можно отследить, связав метод catch:

readFile('/path/to/file.txt')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

Также можно использовать обещанные API в функциях async. Так выглядит основной способ использования обещаний в современном JavaScript: в нём код читается как синхронный, и для обработки ошибок применяют знакомый механизм try / catch. Перед асинхронным запуском важно использовать await, чтобы обещание было выполнено или отклонено до того, как функция возобновит выполнение. При отклонении обещания выражение await выбрасывает отклонённое значение, которое впоследствии попадает в окружающий блок catch.

(async function callReadFile() {
  try {
    const result = await readFile('/path/to/file.txt');
    console.log(result);
  } catch (err) {
    console.error(err);
  }
})();

Обещанияможно использовать в асинхронных функциях, возвращая обещание из функции и помещая код функции в обратный вызов обещания. Если есть ошибка, её стоит отклонить (reject) с помощью объекта Error. В противном случае можно разрешить (resolve) обещание с результатом, чтобы оно было доступно в цепочке метода .then или напрямую как значение функции async при использовании async / await.

function square(num) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      if (typeof num !== 'number') {
        reject(new TypeError(`Expected number but got: ${typeof num}`));
      }
      const result = num * num;
      resolve(result);
    }, 100);
  });
}
square('8')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

Источники событий

Другой шаблон, подходящий для работы с длительными асинхронными операциями, которые могут приводить к множественным ошибкам или результатам, — это возврат EventEmitter из функции и выдача события как для успешного, так и для неудачного случая:

const { EventEmitter } = require('events');
function emitCount() {
  const emitter = new EventEmitter();
  let count = 0;
  // Async operation
  const interval = setInterval(() => {
    count++;
    if (count % 4 == 0) {
      emitter.emit(
        'error',
        new Error(`Something went wrong on count: ${count}`)
      );
      return;
    }
    emitter.emit('success', count);
    if (count === 10) {
      clearInterval(interval);
      emitter.emit('end');
    }
  }, 1000);
  return emitter;
}

Функция emitCount () возвращает новый эмиттер событий, который сообщает об успешном исходе в асинхронной операции. Она увеличивает значение переменной count и каждую секунду генерирует событие успеха и событие ошибки, если значение count делится на 4. Когда count достигает 10, генерируется событие завершения. Этот шаблон позволяет передавать результаты по мере их поступления вместо ожидания завершения всей операции.

Вот как можно отслеживать и реагировать на каждое из событий, генерируемых функцией emitCount ():

const counter = emitCount();
counter.on('success', (count) => {
  console.log(`Count is: ${count}`);
});
counter.on('error', (err) => {
  console.error(err.message);
});
counter.on('end', () => {
  console.info('Counter has ended');
});

Функция колбэка для каждого прослушивателя событий выполняется независимо, как только событие генерируется. Событие ошибки (error) — это особый случай для Node.js, потому что при отсутствии прослушивателя процесс Node.js выходит из строя. Вы можете закомментировать прослушиватель событий ошибки выше и запустить программу, чтобы увидеть, что произойдёт.

Расширение объекта ошибки

Необходимо создавать собственные пользовательские классы ошибок, чтобы лучше отражать разные типы ошибок: класс ValidationError для ошибок, возникающих при проверке пользовательского ввода, класс DatabaseError для операций с базами данных, TimeoutError для операций, для которых истекло назначенное им время ожидания.

Пользовательские классы ошибок, расширяющие объект Error, сохранят основные свойства ошибки: сообщение (message), имя (name) и стек (stack). Но у них есть собственные свойства. ValidationError можно улучшить, добавив значимые свойства — часть ввода, вызвавшую ошибку.

Вот как можно расширить встроенный объект Error в Node.js:

class ApplicationError extends Error {
  constructor(message) {
    super(message);
    // name is set to the name of the class
    this.name = this.constructor.name;
  }
}
class ValidationError extends ApplicationError {
  constructor(message, cause) {
    super(message);
    this.cause = cause
  }
}

Класс ApplicationError — общая ошибка, а класс ValidationError представляет любую ошибку, возникающую при проверке ввода данных пользователем. Он наследуется от класса ApplicationError и дополняет его свойством cause для указания ввода, вызвавшего ошибку. Пользовательские классы ошибки можно использовать, как и обычные:

function validateInput(input) {
  if (!input) {
    throw new ValidationError('Only truthy inputs allowed', input);
  }
  return input;
}
try {
  validateInput(userJson);
} catch (err) {
  if (err instanceof ValidationError) {
    console.error(`Validation error: ${err.message}, caused by: ${err.cause}`);
    return;
  }
  console.error(`Other error: ${err.message}`);
}

Ключевое слово instanceof следует использовать для проверки конкретного типа ошибки. Не используйте имя ошибки для проверки типа, как в err.name === 'ValidationError': это не сработает, если ошибка получена из подкласса ValidationError.

Типы ошибок

Типы ошибок можно разделить на две основные категории: ошибки программиста и операционные проблемы. К первому типу можно отнести неудачные или неправильные аргументы функции, в то время как временные сбои при работе с внешними API однозначно относятся ко второй категории.

Операционные ошибки

Операционные ошибки — это предсказуемые ошибки, которые возникают в процессе выполнения приложения. Это не обязательно баги, чаще это даже внешние обстоятельства, способные нарушить ход выполнения программы. В таких случаях можно полностью понять влияние ошибки на процессы:

Запрос API не выполняется по какой-либо причине (например, сервер не работает или превышен лимит скорости).
Соединение с базой данных потеряно, например, из-за неисправного сетевого соединения.
ОС не может выполнить запрос на открытие файла или запись в него.
Пользователь отправляет на сервер недопустимые данные: неверный номер телефона или адрес электронной почты.

Ошибки программиста

Ошибки программиста — это ошибки в логике или синтаксисе программы, которые можно исправить только путём изменения исходного кода. Ошибки этого типа невозможно обработать, потому что это недочёты в программе:

Синтаксические ошибки: незакрытая фигурная скобка.
Ошибки типа при попытке сделать что-то неправильное: выполнение операций с операндами несовпадающих типов.
Неверные параметры при вызове функции.
Ссылки на ошибки при неправильном написании имени переменной, функции или свойства.
Попытка получить доступ к местоположению за концом массива.
Неспособность обработать операционную ошибку.

Обработка операционных ошибок

Операционные ошибки в большинстве случаев предсказуемы. Их обработка — это рассмотрение вероятности неудачного завершения операции, возможных причин и последствий. Рассмотрим несколько стратегий обработки операционных ошибок в Node.js.

Сообщить об ошибке в стек

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

Повторить операцию

Сетевые запросы к внешним службам иногда могут завершаться ошибкой, даже если запрос полностью верен. Это случается из-за сбоя и неполадках сети или перегрузке сервера. Можно повторить запрос несколько раз, пока он не будет успешно завершён или пока не будет достигнуто максимальное количество повторных попыток. Первое, что нужно сделать, — это определить, уместно ли повторить запрос. Если исходный код состояния HTTP ответа — 500, 503 или 429, повторте запрос через некоторое время.

Проверьте, присутствует ли в ответе HTTP-заголовок Retry-After. Он указывает на точное время ожидания перед выполнением последующего запроса. Если его нет, необходимо отложить последующий запрос и постепенно увеличивать временной промежуток для каждой повторной попытки. Этот метод известен как стратегия экспоненциального отката. Нужно ещё определить максимальное время задержки и число запросов до отказа от дальнейших попыток.

Отправить ошибку клиенту

По умолчанию пользователи вводят данные неправильно. Поэтому первое, что нужно сделать перед запуском каких-либо процессов, — проверить введённые данные и незамедлительно сообщить пользователю о любых ошибках. При обработке ошибок клиента обязательно включите всю информацию, необходимую для создания сообщения об ошибке и имеющую смысл для пользователя.

Прервать программу.

В случае неисправимых системных ошибок разумный выход — зарегистрировать ошибку и немедленно завершить работу программы. Если исключение невозможно исправить на уровне JavaScript, то, возможно, не получится корректно завершить работу сервера. Тогда нужен системный администратор, способный всё исправить.

Предотвращение ошибок программиста

Ошибки программиста сами по себе не могут быть обработаны, потому что их причина в коде или в логике. Однако ошибаться можно реже.

Принять TypeScript

TypeScript — это строго типизированное надмножество JavaScript. Основная цель его проектирования — статическая идентификация потенциально ошибочных конструкций без штрафных санкций во время выполнения. Принимая TypeScript в проекте (с максимально возможными параметрами компилятора), можно устранить целый класс ошибок программиста в ходе компиляции.

Когда проект на TypeScript, такие ошибки, как undefined is not a function, синтаксические или ссылочные ошибки, исчезают из кодовой базы. Перенос на TypeScript можно выполнять постепенно. Для быстрой миграции есть инструмент ts-migrate.

Определить поведение для неверных параметров

Многие ошибки возникают из-за передачи неверных параметров. Это может быть связано не только с очевидными ошибками, такими как передача строки вместо числа, но и с небольшими погрешностями, когда аргумент функции имеет правильный тип, но выходит за пределы диапазона, который функция способна обработать. Когда функция вызывается таким образом, она может выдать неверное значение, например NaN. Когда сбой обнаруживается, сперва трудно определить его причину.

При работе с неверными параметрами и определяйте их поведение, либо выдавая ошибку, либо возвращая специальное значение, такое как null, undefined или -1, когда проблема может быть решена локально. Первый вариант— это подход, используемый JSON.parse (), который выдаёт исключение SyntaxError, если строка для синтаксического анализа недействительна. Второй вариант — метод string.indexOf () .

Автоматизированное тестирование

Автоматизированные наборы тестов повышает вероятность исправления ошибок. Тесты помогают выяснить, как функция работает с нетипичными значениями. Для модульного тестирования подходят среды, такие как Jest или Mocha.

Неперехваченные исключения и необработанные отклонения обещаний

Неперехваченные исключения и необработанные отклонения обещаний вызываются ошибками программиста. Событие uncaughtException генерируется, когда исключение не перехватывается до того как достигнет цикла обработки событий. При обнаружении неперехваченного исключения приложение немедленно выходит из строя. Для переопределения такого поведения всегда можно добавить обработчик события:

// unsafe
process.on('uncaughtException', (err) => {
  console.error(err);
});

Но неперехваченное исключение указывает на то, что приложение находится в неопределённом состоянии. Поэтому попытка возобновить работу в обычном режиме без восстановления после ошибки небезопасна и может привести к утечке памяти и зависанию сокетов. Лучше использовать обработчик uncaught Exception для очистки всех выделенных ресурсов, закрытия соединений и ведения лога ошибок для оценки перед завершением процесса.

// better
process.on('uncaughtException', (err) => {
  Honeybadger.notify(error); // log the error in a permanent storage
  // attempt a gracefully shutdown
  server.close(() => {
    process.exit(1); // then exit
  });
  // If a graceful shutdown is not achieved after 1 second,
  // shut down the process completely
  setTimeout(() => {
    process.abort(); // exit immediately and generate a core dump file
  }, 1000).unref()
});

Событие unhandledRejection генерируется, когда отклонённое обещание не обрабатывается блоком catch. В отличие от uncaughtException, эти события не вызывают немедленного сбоя приложения. Однако необработанные отклонения обещаний сейчас признаны устаревшими и могут немедленно завершить процесс в следующих релизах Node.js. Отслеживать необработанные отклонения обещаний можно с помощью прослушивателя событий unhandledRejection:

process.on('unhandledRejection', (reason, promise) => {
  Honeybadger.notify({
    message: 'Unhandled promise rejection',
    params: {
      promise,
      reason,
    },
  });
  server.close(() => {
    process.exit(1);
  });
  setTimeout(() => {
    process.abort();
  }, 1000).unref()
});

Серверы необходимо запускать с помощью диспетчера процессов, который автоматически перезапустит их в случае сбоя. Распространённый вариант — PM2, но для Linux существуют также systemd и upstart, а пользователи Docker могут использовать собственную политику перезапуска. По завершении всех процессов стабильное обслуживание будет восстановлено почти мгновенно, а у вас будт информация о неперехваченном исключении. Можно запутсить несколько процессов и применить балансировщик нагрузки для распределения входящих запросов. Это поможет предотвратить простои.

Централизованная отчётность об ошибках

Ни одна стратегия обработки ошибок не будет полной без надёжной стратегии ведения журнала ошибок. Когда происходит сбой, важно узаписать как можно больше информации о проблеме. Централизация логов позволяет оценить, что происходит в коде.

Honeybadger предоставляет всё необходимое для отслеживания ошибок. Интегрируется так:

Установите пакет

Используйте npm для установки пакета:

$ npm install @honeybadger-io/js --save

Импортируйте библиотеку

Импортируйте библиотеку и настройте её с помощью ключа API, чтобы получать сообщения об ошибках:

const Honeybadger = require('@honeybadger-io/js');
Honeybadger.configure({
  apiKey: '[ YOUR API KEY HERE ]'
});
Сообщите об ошибках
Метоодом notify ():
try {
  // ...error producing code
} catch(error) {
  Honeybadger.notify(error);
}

Просмотрите полную документацию или ознакомьтесь с образцом Node.js / Express на GitHub.

Без обработки ошибок не бывает надёжного софта.

Спасибо за внимание и удачного кода!

Источник

Данная статья является переводом. Ссылка на оригинал.

В статье рассмотрим:

Объект Error
Try…catch
Throw
Call stack
Наименование функций
Парадигму асинхронного программирования Promise

Представьте, как разрабатываете RESTful web API на Node.js.

Пользователи отправляют запросы к серверу для получения данных.
Вопрос времени, когда в программу придут значения, которые не ожидались.
В таком случае, когда программа получит эти значения, пользователи будут рады видеть подробное и конкретное описание ошибки.
В случае когда нет соответствующего обработчика ошибки, отобразится стандартное сообщение об ошибке. Таким образом, пользователь увидит сообщение об ошибке «Невозможно выполнить запрос», что не несет полезной информации о том, что произошло.
Поэтому стоит уделять внимание обработке ошибок, чтобы наша программа стала безопасной, отказоустойчивой, высокопроизводительной и без ошибок.

Анатомия Объекта Error

Первое, с чего стоит начать изучение – это объект Error.

Разберем на примере:

        throw new Error('database failed to connect');

Здесь происходят две вещи: создается объект Error и выбрасывается исключение.

Начнем с рассмотрения объекта Error, и того, как он работает. К ключевому слову throw вернемся чуть позже.

Объект Error представляет из себя реализацию функции конструктора, которая использует набор инструкций (аргументы и само тело конструктора) для создания объекта.

Тем не менее, что же такое объекты ошибок? Почему они должны быть однородными? Это важные вопросы, поэтому давайте перейдем к ним.

Первым аргументом для объекта Error является его описание.

Описание – это понятная человеку строка объекта ошибки. Также эта строка появляется в консоли, когда что-то пошло не так.

Объекты ошибок также имеют свойство name, которое рассказывает о типе ошибки. Когда создается нативный объект ошибки, то свойство name по умолчанию содержит Error. Вы также можете создать собственный тип ошибки, расширив нативный объект ошибки следующим образом:

        class FancyError extends Error {
    constructor(args){
        super(args);
        this.name = "FancyError"
    }
}

console.log(new Error('A standard error'))
// { [Error: A standard error] }

console.log(new FancyError('An augmented error'))
// { [Your fancy error: An augmented error] name: 'FancyError' }

Обработка ошибок становится проще, когда у нас есть согласованность в объектах.

Ранее мы упоминали, что хотим, чтобы объекты ошибок были однородными. Это поможет обеспечить согласованность в объекте ошибки.

Теперь давайте поговорим о следующей части головоломки – throw.

Ключевое слово Throw

Создание объектов ошибок – это не конец истории, а только подготовка ошибки к отправке. Отправка ошибки заключается в том, чтобы выбросить исключение. Но что значит выбросить? И что это значит для нашей программы?

Throw делает две вещи: останавливает выполнение программы и находит зацепку, которая мешает выполнению программы.

Давайте рассмотрим эти идеи одну за другой:

Когда JavaScript находит ключевое слово throw, первое, что он делает – предотвращает запуск любых других функций. Остановка снижает риск возникновения любых дальнейших ошибок и облегчает отладку программ.
Когда программа остановлена, JavaScript начнет отслеживать последовательную цепочку функций, которые были вызваны для достижения оператора catch. Такая цепочка называется стек вызовов (англ. call stack). Ближайший catch, который находит JavaScript, является местом, где возникает выброшенное исключение. Если операторы try/catch не найдены, тогда возникает исключение, и процесс Node.js завершиться, что приведет к перезапуску сервера.

Бросаем исключения на примере

Мы рассмотрели теорию, а теперь давайте изучим пример:

        function doAthing() {
    byDoingSomethingElse();
}

function byDoingSomethingElse() {
    throw new Error('Uh oh!');
}

function init() {
    try {
        doAthing();
    } catch(e) {
        console.log(e);
        // [Error: Uh oh!]
    }
}

init();

Здесь в функции инициализации init() предусмотрена обработка ошибок, поскольку она содержит try/catch блок.

init() вызывает функцию doAthing(), которая вызывает функцию byDoingSomethingElse(), где выбрасывается исключение. Именно в этот момент ошибки, программа останавливается и начинает отслеживать функцию, вызвавшую ошибку. Далее в функции init() и выполняет оператор catch. С помощью оператора catch мы решаем что делать: подавить ошибку или даже выдать другую ошибку (для распространения вверх).

Стек вызовов

То, что показано в приведенном выше примере – это проработанный пример стека вызовов. Как и большинство языков, JavaScript использует концепцию, известную как стек вызовов.

Но как работает стек вызовов?

Всякий раз, когда вызывается функция, она помещается в стек, а при завершении удаляется из стека. Именно от этого стека мы получили название «трассировки стека».

Трассировка стека – это список функций, которые были вызваны до момента, когда в программе произошло исключение.

Она часто выглядит так:

        Error: Uh oh!
at byDoingSomethingElse (/filesystem/aProgram.js:7:11)
at doAthing (/filesystem/aProgram.js:3:5)
at init (/filesystem/aProgram.js:12:9)
at Object.<anonymous> (/filesystem/aProgram.js:19:1)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Function.Module.runMain (internal/modules/cjs/loader.js:742:12)

На этом этапе вам может быть интересно, как стек вызовов помогает нам с обработкой ошибок Node.js. Давайте поговорим о важности стеков вызовов.

Стек вызовов предоставляет «хлебные крошки», помогая проследить путь, который привел к исключению(ошибке).

Почему у нас должны быть функции без имен? Иногда в наших программах мы хотим определить маленькие одноразовые функции, которые выполняют небольшую задачу. Мы не хотим утруждать себя задачей давать им имена, но именно эти анонимные функции могут вызвать у нас всевозможные головные боли. Анонимная функция удаляет имя функции из нашего стека вызовов, что делает наш стек вызовов значительно более сложным в использовании.

Обратите внимание, что присвоить имена функциям в JavaScript не так просто. Итак, давайте кратко рассмотрим различные способы определения функций, и рассмотрим некоторые ловушки в именовании функций.

Как называть функции

Чтобы понять, как называть функции, давайте рассмотрим несколько примеров:

        // анонимная функция
const one = () => {};

// анонимная функция
const two = function () {};

// функция с явным названием
const three = function explicitFunction() {};

Вот три примера функций.

Первая – это лямбда (или стрелочная функция). Лямбда функции по своей природе анонимны. Не запутайтесь. Имя переменной one не является именем функции. Имя функции следующее за ключевым словом function необязательно. Но в этом примере мы вообще ничего не передаем, поэтому наша функция анонимна.

Примечание

Не помогает и то, что некоторые среды выполнения JavaScript, такие как V8, могут иногда угадывать имя вашей функции. Это происходит, даже если вы его не даете.

Во втором примере мы получили функциональное выражение. Это очень похоже на первый пример. Это анонимная функция, но просто объявленная с помощью ключевого слова function вместо синтаксиса жирной стрелки.

В последнем примере объявление переменной с подходящим именем explicitFunction. Это показывает, что это единственная функция, у которой соответствующее имя.

Как правило, рекомендуется указывать это имя везде, где это возможно, чтобы иметь более удобочитаемую трассировку стека.

Обработка асинхронных исключений

Мы познакомились с объектом ошибок, ключевым словом throw, стеком вызовов и наименованием функций. Итак, давайте обратим наше внимание на любопытный случай обработки асинхронных ошибок. Почему? Потому что асинхронный код ведет себя не так, как ожидаем. Асинхронное программирование необходимо каждому программисту на Node.js.

Javascript – это однопоточный язык программирования, а это значит, что Javascript запускается с использованием одного процессора. Из этого следует, что у нас есть блокирующий и неблокирующий код. Блокирующий код относится к тому, будет ли ваша программа ожидать завершения асинхронной задачи, прежде чем делать что-либо еще. В то время как неблокирующий код относится к тому, где вы регистрируете обратный вызов (callback) для выполнения после завершения задачи.

Стоит упомянуть, что есть два основных способа обработки асинхронности в JavaScript: promises (обещания или промисы) и callback (функция обратного вызова). Мы намеренно игнорируем async/wait, чтобы избежать путаницы, потому что это просто сахар поверх промисов.

В статье мы сфокусируемся на промисах. Существует консенсус в отношении того, что для приложений промисы превосходят обратные вызовы с точки зрения стиля программирования и эффективности. Поэтому в этой статье проигнорируем подход с callback-ами, и предположим, что вместо него вы выберете promises.

Примечание

Существует множество способов конвертировать код на основе callback-ов в promises. Например, вы можете использовать такую утилиту, как promisify, или обернуть свои обратные вызовы в промисы, например, так:

        var request = require('request'); //http wrapped module
function requestWrapper(url, callback) {
    request.get(url, function (err, response) {
        if (err) {
            callback(err);
        } else {
            callback(null, response);
        }
    })
}

Мы разберемся с этой ошибкой, обещаю!

Давайте взглянем на анатомию обещаний.

Промисы в JavaScript – это объект, представляющий будущее значение. Promise API позволяют нам моделировать асинхронный код так же, как и синхронный. Также стоит отметить, что обещание обычно идет в цепочке, где выполняется одно действие, затем другое и так далее.

Но что все это значит для обработки ошибок Node.js?

Промисы элегантно обрабатывают ошибки и перехватывают любые ошибки, которые им предшествовали в цепочке. С помощью одного обработчика обрабатывается множество ошибок во многих функциях.

Изучим код ниже:

        function getData() {
    return Promise.resolve('Do some stuff');
}

function changeDataFormat() {
    // ...
}

function storeData(){
    // ...
}

getData()
    .then(changeDataFormat)
    .then(storeData)
    .catch((e) => {
        // Handle the error!
    })

Здесь видно, как объединить обработку ошибок для трех различных функций в один обработчик, т. е. код ведет себя так же, как если бы три функции заключались в синхронный блок try/catch.

Отлавливать или не отлавливать?

На данном этапе стоит спросить себя, повсеместно ли добавляется .catch к промисам, поскольку это опционально. Из-за проблем с сетью, аппаратного сбоя или истекшего времени ожидания в асинхронных вызовах возникает исключение. По этим причинам указывайте программе, что делать в случаях невыполнения промиса.

Запомните «Золотое правило» – каждый раз обрабатывать исключения в обещаниях.

Риски асинхронного try/catch

Мы приближаемся к концу в нашем путешествии по обработке ошибок в Node.js. Пришло время поговорить о ловушках асинхронного кода и оператора try/catch.

Вам может быть интересно, почему промис предоставляет метод catch, и почему мы не можем просто обернуть нашу реализацию промиса в try/catch. Если бы вы сделали это, то результаты были бы не такими, как вы ожидаете.

Рассмотрим на примере:

        try {
    throw new Error();
} catch(e) {
    console.log(e); // [Error]
}

try {
    setTimeout(() => {
        throw new Error();
    }, 0);
} catch(e) {
    console.log(e); // Nothing, nada, zero, zilch, not even a sound
}

try/catch по умолчанию синхронны, что означает, что если асинхронная функция выдает ошибку в синхронном блоке try/catch, ошибка не будет брошена.

Однозначно это не то, что ожидаем.

***

Подведем итог! Необходимо использовать обработчик промисов, когда мы имеем дело с асинхронным кодом, а в случае с синхронным кодом подойдет try/catch.

Заключение

Из этой статьи мы узнали:

как устроен объект Error;
научились создавать свои собственные ошибки;
как работает стек вызовов;
практики наименования функций, для удобочитаемой трассировки стека;
как обрабатывать асинхронные исключения.

***

Материалы по теме

🗄️ 4 базовых функции для работы с файлами в Node.js
Цикл событий: как выполняется асинхронный JavaScript-код в Node.js
Обработка миллионов строк данных потоками на Node.js

Источник

Node.js is a JavaScript extension used for server-side scripting. Error handling is a mandatory step in application development. A Node.js developer may work with both synchronous and asynchronous functions simultaneously. Handling errors in asynchronous functions is important because their behavior may vary, unlike synchronous functions. While try-catch blocks are effective for synchronous functions, asynchronous functions can be dealt with callbacks, promises, and async-await. Try-catch is synchronous means that if an asynchronous function throws an error in a synchronous try/catch block, no error throws. Errors thrown in Node.js applications can be handled in the following ways:

Using try-catch block
Using callbacks
Using promises and promise callbacks
Using async-await

Using try-catch block: The try-catch block can be used to handle errors thrown by a block of code.

function dosomething(){

throw new Error(

'a error is thrown from dosomething');

}

function init(){

try{

dosomething();

}

catch(e){

console.log(e);

}

console.log(

"After successful error handling");

}

init();

Output:

Error: a error is thrown from dosomething
    at dosomething (/home/cg/root/6422736/main.js:4:11)
    at init (/home/cg/root/6422736/main.js:9:9)
    at Object. (/home/cg/root/6422736/main.js:17:1)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:389:7)
After successful error handling

Explanation: The init() function is called which in turn calls dosomething() function which throws an error object. This error object is caught by the catch block of the init() method. If there is no proper handling of the error the program will terminate. The catch block prints the call stack to show the point where the error occurred.

Using callbacks: A callback is a function called at the completion of a certain task. Callbacks are widely used in Node.js as it prevents any blocking, and allows other code to be run in the meantime. The program does not wait for file reading to complete and proceeds to print “Program Ended” while continuing to read the file. If any error occurs like file does not exist in the system then the error is printed after “Program Ended”, else the content of the file is outputted.

var fs = require("fs");

fs.readFile('foo.txt', function (err, data) {

if (err) {

console.error(err);

}else{

console.log(data.toString());

}

});

console.log("Program Ended");

Output:

Program Ended
[Error: ENOENT: no such file or directory, 
  open 'C:UsersUserDesktopfoo.txt'] {
  errno: -4058,
  code: 'ENOENT',
  syscall: 'open',
  path: 'C:\Users\User\Desktop\foo.txt'
}

Explanation: In this case, the file does not exist in the system hence the error is thrown.

Using promises and promise callbacks: Promises are an enhancement to Node.js callbacks. When defining the callback, the value which is returned is called a “promise”. The key difference between a promise and a callback is the return value. There is no concept of a return value in callbacks. The return value provides more control for defining the callback function. In order to use promises, the promise module must be installed and imported in the application. The .then clause handles the output of the promise. If an error occurs in any .then clause or if any of the promises above rejects, it is passed to the immediate .catch clause. In case of a promise being rejected, and there is no error handler then the program terminates.

var Promise = require('promise');

var MongoClient = require('mongodb').MongoClient;

MongoClient.connect(url)

.then(function(err, db) {

db.collection('Test').updateOne({

"Name": "Joe"

}, {

$set: {

"Name": "Beck"

}

});

.catch(error => alert(error.message))

Output:

// In this case we assume the url is wrong
MongoError: failed to connect to server [localhost:27017]
// error message may vary

Using async-await: Async-await is a special syntax to work with promises in a simpler way that is easy to understand. When we use async/await, .then is replaced by await which handles the waiting in the function. The error handling is done by the .catch clause. Async-await can also be wrapped in a try-catch block for error handling. In case no error handler exists the program terminates due to uncaught error.

async function f() {

}

f().catch(alert);

Output:

// the url is wrong //
TypeError: failed to fetch

Источник

Using try-catch block
Using callbacks
Using promises and promise callbacks
Using async-await

Using try-catch block: The try-catch block can be used to handle errors thrown by a block of code.

function dosomething(){

throw new Error(

'a error is thrown from dosomething');

}

function init(){

try{

dosomething();

}

catch(e){

console.log(e);

}

console.log(

"After successful error handling");

}

init();

Output:

Error: a error is thrown from dosomething
    at dosomething (/home/cg/root/6422736/main.js:4:11)
    at init (/home/cg/root/6422736/main.js:9:9)
    at Object. (/home/cg/root/6422736/main.js:17:1)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:389:7)
After successful error handling

var fs = require("fs");

fs.readFile('foo.txt', function (err, data) {

if (err) {

console.error(err);

}else{

console.log(data.toString());

}

});

console.log("Program Ended");

Output:

Program Ended
[Error: ENOENT: no such file or directory, 
  open 'C:UsersUserDesktopfoo.txt'] {
  errno: -4058,
  code: 'ENOENT',
  syscall: 'open',
  path: 'C:\Users\User\Desktop\foo.txt'
}

Explanation: In this case, the file does not exist in the system hence the error is thrown.

var Promise = require('promise');

var MongoClient = require('mongodb').MongoClient;

MongoClient.connect(url)

.then(function(err, db) {

db.collection('Test').updateOne({

"Name": "Joe"

}, {

$set: {

"Name": "Beck"

}

});

.catch(error => alert(error.message))

Output:

// In this case we assume the url is wrong
MongoError: failed to connect to server [localhost:27017]
// error message may vary

async function f() {

}

f().catch(alert);

Output:

// the url is wrong //
TypeError: failed to fetch

Источник

Если вы писали что-то большее, чем программы «Hello world», вы, вероятно, знакомы с концепцией ошибок в программировании. Это ошибки в вашем коде, часто называемые «bugs», которые приводят к сбою программы или неожиданному поведению. В отличие от некоторых языков, таких как Go и Rust, где вы вынуждены взаимодействовать с потенциальными ошибками на каждом этапе пути, в JavaScript и Node.js можно обойтись без согласованной стратегии обработки ошибок.

Однако это не обязательно должно быть так, потому что обработка ошибок Node.js может быть довольно простой, если вы знакомы с шаблонами, используемыми для создания, доставки и обработки потенциальных ошибок. Эта статья призвана познакомить вас с этими шаблонами, чтобы вы могли сделать свои программы более надежными, гарантируя, что вы обнаружите потенциальные ошибки и обработаете их надлежащим образом, прежде чем развертывать свое приложение в рабочей среде!

Что такое ошибки в Node.js

Ошибка в Node.js — это любой экземпляр объекта Error. Типичные примеры включают встроенные классы ошибок, таких как ReferenceError, RangeError, TypeError, URIError, EvalError, и SyntaxError. Определяемые пользователем ошибки также можно создавать путем расширения базового объекта Error, встроенного класса ошибок или другой пользовательской ошибки. При создании ошибок таким образом вы должны передать строку сообщения, описывающую ошибку. Доступ к этому сообщению можно получить через свойство объекта message. Объект Error также содержит name в свойстве stack, указав имя ошибки и точки в коде, на котором он был создан, соответственно.

const userError = new TypeError("Something happened!");
console.log(userError.name); // TypeError
console.log(userError.message); // Something happened!
console.log(userError.stack);
/*TypeError: Something happened!
    at Object.<anonymous> (/home/ayo/dev/demo/main.js:2:19)
    <truncated for brevity>
    at node:internal/main/run_main_module:17:47 */

Получив объект Error, вы можете передать его функции или вернуть из функции. Вы также можете сделать throw, что приведет к тому, что объект Error станет исключением. Как только вы выдаете ошибку, она всплывает в стеке до тех пор, пока ее где-нибудь не поймают. Если вам не удастся еt поймать, онf станет неперехваченным исключением, которое может привести к сбою вашего приложения!

Как устранить ошибки

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

1. Исключения

Наиболее распространенный способ устранения ошибок функциями — их генерация. Когда вы выдаете ошибку, она становится исключением и должна быть перехвачена где-то в стеке с помощью блока try/catch. Если ошибка может всплывать в стеке без обнаружения, она становится uncaughtException, что приводит к преждевременному завершению работы приложения. Например, встроенный метод JSON.parse() выдает ошибку, если его строковый аргумент не является допустимым объектом JSON.

function parseJSON(data) {
  return JSON.parse(data);
}

try {
  const result = parseJSON('A string');
} catch (err) {
  console.log(err.message); // Unexpected token A in JSON at position 0
}

Чтобы использовать этот шаблон в своих функциях, все, что вам нужно сделать, это добавить ключевое слово throw перед экземпляром ошибки. Этот шаблон сообщения об ошибках и их обработки идиоматичен для функций, выполняющих синхронные операции.

function square(num) {
  if (typeof num !== 'number') {
    throw new TypeError(`Expected number but got: ${typeof num}`);
  }

  return num * num;
}

try {
  square('8');
} catch (err) {
  console.log(err.message); // Expected number but got: string
}

2. Обратные вызовы с ошибкой

Из-за своей асинхронной природы Node.js широко использует функции обратного вызова для большей части обработки ошибок. Функция обратного вызова передается в качестве аргумента другой функции и выполняется, когда функция завершает свою работу. Если вы какое-то время писали код JavaScript, вы, вероятно, знаете, что шаблон обратного вызова широко используется во всем коде JavaScript.

Node.js использует в большинстве своих асинхронных методов соглашение об обратном вызове «сначала ошибка», чтобы убедиться, что ошибки проверяются должным образом до того, как будут использованы результаты операции. Эта функция обратного вызова обычно является последним аргументом функции, инициирующей асинхронную операцию, и вызывается один раз при возникновении ошибки или при получении результата операции. Ее подпись показана ниже:

function (err, result) {}

Первый аргумент зарезервирован для объекта ошибки. Если в ходе асинхронной операции возникает ошибка, она будет доступна через аргумент err и result будет иметь значение undefined. Однако, если ошибки не возникнет err будет null или undefined и result будет содержать ожидаемый результат операции. Этот шаблон можно продемонстрировать, прочитав содержимое файла с помощью встроенного метода fs.readFile():

const fs = require('fs');

fs.readFile('/path/to/file.txt', (err, result) => {
  if (err) {
    console.error(err);
    return;
  }

  // Log the file contents if no error
  console.log(result);
});

Как вы можете видеть метод readFile() ожидает функцию обратного вызова в качестве своего последнего аргумента, который придерживается описанной ранее сигнатуры функции «сначала ошибка». В этом сценарии аргумент result содержит содержимое прочитанного файла, если не возникает ошибки. В противном случае undefined и аргумент err заполняется объектом ошибки, содержащим информацию о проблеме (например, файл не найден или недостаточные разрешения).

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

Если вы хотите использовать этот шаблон обратного вызова с первой ошибкой в своих собственных асинхронных функциях, все, что вам нужно сделать, это принять функцию в качестве последнего аргумента и вызвать ее, как показано ниже:

function square(num, callback) {
  if (typeof callback !== 'function') {
    throw new TypeError(`Callback must be a function. Got: ${typeof callback}`);
  }

  // simulate async operation
  setTimeout(() => {
    if (typeof num !== 'number') {
      // if an error occurs, it is passed as the first argument to the callback
      callback(new TypeError(`Expected number but got: ${typeof num}`));
      return;
    }

    const result = num * num;
    // callback is invoked after the operation completes with the result
    callback(null, result);
  }, 100);
}

Любому вызывающему объекту этой функции square потребуется передать функцию обратного вызова, чтобы получить доступ к ее результату или ошибке. Обратите внимание, что во время выполнения возникает исключение, если аргумент обратного вызова не является функцией.

square('8', (err, result) => {
  if (err) {
    console.error(err)
    return
  }

  console.log(result);
});

Вам не нужно напрямую обрабатывать ошибку в функции обратного вызова. Вы можете распространить его вверх по стеку, передав его другому обратному вызову, но не генерируйте исключение из функции, потому что оно не будет перехвачено, даже если вы окружите код блоком try/catch. Асинхронное исключение невозможно перехватить, поскольку окружающий блок try/catch завершается до выполнения обратного вызова. Таким образом, исключение будет распространяться на вершину стека, вызывая сбой приложения, если для него не зарегистрирован обработчик process.on('uncaughtException'), который будет обсуждаться позже.

try {
  square('8', (err, result) => {
    if (err) {
      throw err; // not recommended
    }

    console.log(result);
  });
} catch (err) {
  // This won't work
  console.error("Caught error: ", err);
}

3. Отказ от промисов

Промисы — это современный способ выполнения асинхронных операций в Node.js, и в настоящее время они обычно предпочтительнее обратных вызовов, потому что этот подход имеет лучший поток, который соответствует тому, как мы анализируем программы, особенно с шаблоном async/await. Любой API-интерфейс Node.js, который использует обратные вызовы для асинхронной обработки ошибок, может быть преобразован в промисы с помощью встроенного метода util.promisify(). Например, вот как можно использовать метод fs.ReadFile() для использования промисов:

const fs = require('fs');
const util = require('util');

const readFile = util.promisify(fs.readFile);

Переменная ReadFile — это обещанная версия fs.ReadFile(), в которой отклонения промисов используются для сообщения об ошибках. Эти ошибки могут быть обнаружены с помощью метода цепочки catch, как показано ниже:

readFile('/path/to/file.txt')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

Вы также можете использовать обещанные API в функции async, такой как показанна ниже. Это преобладающий способ использования обещаний в современном JavaScript, потому что код читается как синхронный код, а для обработки ошибок можно использовать знакомый механизм try/catch. Важно использовать await перед асинхронным методом, чтобы промис был выполнен (выполнен или отклонен) до того, как функция возобновит свое выполнение. Если промис отклоняется, выражение await выдает отклоненное значение, которое впоследствии перехватывается в окружающем блоке catch

(async function callReadFile() {
  try {
    const result = await readFile('/path/to/file.txt');
    console.log(result);
  } catch (err) {
    console.error(err);
  }
})();

Вы можете использовать промисы в своих асинхронных функциях, возвращая промис из функции и помещая код функции в обратный вызов промиса. Если есть ошибка, reject с объектом Error. В противном случае resolve промис с результатом, чтобы оно было доступно в цепочке метода .then или непосредственно в качестве значения функции async при использовании async/await.

function square(num) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      if (typeof num !== 'number') {
        reject(new TypeError(`Expected number but got: ${typeof num}`));
      }

      const result = num * num;
      resolve(result);
    }, 100);
  });
}

square('8')
  .then((result) => console.log(result))
  .catch((err) => console.error(err));

4. Генераторы событий

Другой шаблон, который можно использовать при работе с длительными асинхронными операциями, которые могут привести к множеству ошибок или результатов, заключается в возврате EventEmitter из функции и создании события как в случае успеха, так и в случае неудачи. Пример этого кода показан ниже:

const { EventEmitter } = require('events');

function emitCount() {
  const emitter = new EventEmitter();

  let count = 0;
  // Async operation
  const interval = setInterval(() => {
    count++;
    if (count % 4 == 0) {
      emitter.emit(
        'error',
        new Error(`Something went wrong on count: ${count}`)
      );
      return;
    }
    emitter.emit('success', count);

    if (count === 10) {
      clearInterval(interval);
      emitter.emit('end');
    }
  }, 1000);

  return emitter;
}

Функция emitCount() возвращает новый источник событий, который сообщает как об успехе, так и о сбое в асинхронной операции. Функция увеличивает переменную count и генерирует событие success каждую секунду, а также событие error, если count делится на 4. Когда count достигает 10, генерируется событие end. Этот шаблон позволяет выполнять потоковую передачу результатов по мере их поступления, а не ждать завершения всей операции.

Вот как вы можете обрабатывать и реагировать на каждое из событий, исходящих от функции emitCount():

const counter = emitCount();

counter.on('success', (count) => {
  console.log(`Count is: ${count}`);
});

counter.on('error', (err) => {
  console.error(err.message);
});

counter.on('end', () => {
  console.info('Counter has ended');
});

Как вы можете видеть на изображении выше, функция обратного вызова для каждого обработчика событий выполняется независимо, как только событие генерируется. Событие error является особым случаем в Node.js, потому что, если для него нет обработчика, процесс Node.js завершится сбоем. Вы можете закомментировать обработчик событий error выше и запустить программу, чтобы посмотреть, что произойдет.

Расширение объекта ошибки

Использование встроенных классов ошибок или универсального экземпляра объекта Error обычно недостаточно точно для сообщения всех различных типов ошибок. Поэтому необходимо создавать пользовательские классы ошибок, чтобы лучше отражать типы ошибок, которые могут возникнуть в вашем приложении. Например, у вас может быть класс ValidationError для ошибок, возникающих при проверке пользовательского ввода, DatabaseError для операций с базой данных, класс TimeoutError для операций, для которых истекают назначенные им тайм-ауты, и так далее.

Пользовательские классы ошибок, расширяющие объект ошибки, сохранят основные свойства ошибки, такие как message, name, и stack, но они также могут иметь собственные свойства. Например ValidationError можно улучшить, добавив значимые свойства, такие как часть ввода, вызвавшую ошибку. По сути, вы должны включить достаточно информации, чтобы обработчик ошибок правильно обработал ошибку или создал свои собственные сообщения об ошибках.

Вот как расширить встроенный объект Error в Node.js:

class ApplicationError extends Error {
  constructor(message) {
    super(message);
    // name is set to the name of the class
    this.name = this.constructor.name;
  }
}

class ValidationError extends ApplicationError {
  constructor(message, cause) {
    super(message);
    this.cause = cause
  }
}

Приведенный выше класс ApplicationError является общей ошибкой для приложения, а класс ValidationError представляет любую ошибку, возникающую при проверке пользовательского ввода. Он наследуется от класса ApplicationError и дополняет его свойством cause, чтобы указать ввод, вызвавший ошибку. Вы можете использовать пользовательские ошибки в своем коде так же, как и с обычной ошибкой. Например, вы можете throw:

function validateInput(input) {
  if (!input) {
    throw new ValidationError('Only truthy inputs allowed', input);
  }

  return input;
}

try {
  validateInput(userJson);
} catch (err) {
  if (err instanceof ValidationError) {
    console.error(`Validation error: ${err.message}, caused by: ${err.cause}`);
    return;
  }

  console.error(`Other error: ${err.message}`);
}

Ключевое слово instanceof следует использовать для проверки определенного типа ошибок, как показано выше. Не используйте имя ошибки для проверки типа, как в err.name === 'ValidationError', потому что это не сработает, если ошибка получена из подкласса ValidationError.

Типы ошибок

Полезно различать разные типы ошибок, которые могут возникнуть в приложении Node.js. Как правило, ошибки можно разделить на две основные категории: ошибки программиста и операционные проблемы. Плохие или неверные аргументы функции — это пример проблем первого типа, тогда как временные сбои при работе с внешними API относятся ко второй категории.

1. Операционные ошибки

Операционные ошибки — это в основном ожидаемые ошибки, которые могут возникнуть в процессе выполнения приложения. Это не обязательно ошибки, но внешние обстоятельства, которые могут нарушить ход выполнения программы. В таких случаях все последствия ошибки можно понять и соответствующим образом обработать. Некоторые примеры операционных ошибок в Node.js включают следующее:

Запрос API завершается ошибкой по какой-либо причине (например, сервер не работает или превышен лимит скорости).
Соединение с базой данных потеряно, возможно, из-за неисправного сетевого соединения.
ОС не может выполнить ваш запрос на открытие файла или запись в него.
Пользователь отправляет на сервер неверный ввод, например неверный номер телефона или адрес электронной почты.

Эти ситуации не возникают из-за ошибок в коде приложения, но с ними нужно правильно обращаться. В противном случае они могут вызвать более серьезные проблемы.

2. Ошибки программиста

Ошибки программиста — это ошибки в логике или синтаксисе программы, которые можно исправить только путем изменения исходного кода. Эти типы ошибок не могут быть обработаны, потому что по определению они являются ошибками в программе. Вот некоторые примеры ошибок программиста:

Синтаксические ошибки, такие как невозможность закрыть фигурную скобку.
Ошибки типа, когда вы пытаетесь сделать что-то недопустимое, например, выполнять операции с операндами несовпадающих типов.
Неверные параметры при вызове функции.
Ссылочные ошибки при неправильном написании имени переменной, функции или свойства.
Попытка доступа к местоположению за концом массива.
Не удалось обработать операционную ошибку.

Оперативная обработка ошибок

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

1. Сообщите об ошибке вверх по стеку

Во многих случаях подходящим действием является остановка потока выполнения программы, очистка всех незавершенных процессов и сообщение об ошибке вверх по стеку, чтобы ее можно было обработать соответствующим образом. Часто это правильный способ устранения ошибки, когда функция, в которой она возникла, находится ниже по стеку и не имеет достаточно информации для непосредственной обработки ошибки. Сообщить об ошибке можно с помощью любого из методов доставки ошибок, описанных ранее в этой статье.

2. Повторите операцию

Сетевые запросы к внешним службам иногда могут завершаться ошибкой, даже если запрос полностью действителен. Это может быть связано с временным сбоем, который может возникнуть при сбое сети или перегрузке сервера. Такие проблемы обычно непродолжительны, поэтому вместо того, чтобы немедленно сообщать об ошибке, вы можете повторить запрос несколько раз, пока он не будет успешным или пока не будет достигнуто максимальное количество повторных попыток. Первое соображение заключается в том, чтобы определить, уместно ли повторить запрос. Например, если исходный код состояния HTTP-ответа — 500, 503 или 429, может оказаться целесообразным повторить запрос после небольшой задержки.

Вы можете проверить, присутствует ли в ответе HTTP-заголовок Retry-After. В этом заголовке указывается точное время ожидания перед выполнением последующего запроса. Если заголовок Retry-After не существует, вам необходимо отложить последующий запрос и постепенно увеличивать задержку для каждой последующей повторной попытки. Это известно как экспоненциальная стратегия отсрочки. Вам также необходимо определить максимальный интервал задержки и количество повторных попыток запроса, прежде чем отказаться от него. В этот момент вы должны сообщить вызывающему абоненту, что целевая служба недоступна.

3. Отправить ошибку клиенту

Имея дело с внешним вводом от пользователей, следует исходить из того, что ввод неверен по умолчанию. Поэтому первое, что нужно сделать перед запуском каких-либо процессов, — это проверить ввод и незамедлительно сообщить пользователю о любых ошибках, чтобы его можно было исправить и повторно отправить. При доставке ошибок клиента не забудьте включить всю информацию, необходимую клиенту для создания сообщения об ошибке, понятного пользователю.

4. Прервать программу

В случае неисправимых системных ошибок единственным разумным действием является регистрация ошибки и немедленное завершение программы. Возможно, вы даже не сможете корректно завершить работу сервера, если исключение невозможно восстановить на уровне JavaScript. В этот момент от системного администратора может потребоваться изучить проблему и исправить ее, прежде чем программа сможет снова запуститься.

Предотвращение ошибок программиста

Из-за своей природы ошибки программиста не могут быть обработаны; это ошибки в программе, возникающие из-за неработающего кода или логики, которые впоследствии необходимо исправлять. Однако есть несколько вещей, которые вы можете сделать, чтобы значительно снизить частоту их появления в вашем приложении.

1. Примите TypeScript

TypeScript — является строго типизированным надмножеством JavaScript. Его основная цель разработки — статическая идентификация конструкций, которые могут быть ошибочными, без каких-либо штрафов во время выполнения. Приняв TypeScript в свой проект (с максимально строгими параметрами компилятора), вы сможете устранить целый класс ошибок программиста во время компиляции. Например, после проведения постфактум-анализа ошибок было подсчитано, что 38% ошибок в кодовой базе Airbnb можно было предотвратить с помощью TypeScript.

Когда вы переносите весь свой проект на TypeScript, такие ошибки, как « undefined is not a function», синтаксические ошибки или ошибки ссылок, больше не должны существовать в вашей кодовой базе. К счастью, это не так страшно, как кажется. Миграция всего вашего приложения Node.js на TypeScript может выполняться поэтапно, чтобы вы могли сразу же начать пожинать плоды в важнейших частях кодовой базы. Вы также можете использовать такой инструмент, как ts-migrate, если вы собираетесь выполнить миграцию за один раз.

2. Определите поведение для неверных параметров

Многие ошибки программиста возникают из-за передачи неправильных параметров. Это может быть связано не только с очевидными ошибками, такими как передача строки вместо числа, но и с тонкими ошибками, например, когда аргумент функции имеет правильный тип, но выходит за пределы того, что может обработать функция. Когда программа запущена и функция вызывается таким образом, она может незаметно завершиться ошибкой и выдать неправильное значение, например NaN. Когда сбой в конце концов заметен (обычно после прохождения через несколько других функций), может быть трудно определить его причины.

Вы можете справиться с неправильными параметрами, определив их поведение, выдав ошибку или вернув специальное значение, такое как null, undefined, или -1, когда проблема может быть решена локально. Первый — это подход, используемый JSON.parse(), который генерирует исключение SyntaxError, если строка для синтаксического анализа не является допустимой JSON, тогда как метод string.indexOf() является примером последнего. Что бы вы ни выбрали, обязательно задокументируйте, как функция обрабатывает ошибки, чтобы вызывающая сторона знала, чего ожидать.

3. Автоматизированное тестирование

Сам по себе язык JavaScript мало помогает вам найти ошибки в логике вашей программы, поэтому вам нужно запустить программу, чтобы определить, работает ли она должным образом. Наличие набора автоматизированных тестов повышает вероятность того, что вы обнаружите и исправите различные ошибки программиста, особенно логические. Они также помогают выяснить, как функция работает с нетипичными значениями. Использование среды тестирования, такой как Jest или Mocha, — хороший способ начать модульное тестирование приложений Node.js.

Неперехваченные исключения и необработанные отказы от промисов

Неперехваченные исключения и необработанные отклонения промисов вызваны ошибками программиста, возникающими из-за невозможности перехватить сгенерированное исключение и отклонение промисов соответственно. Событие uncaughtException возникает, когда исключение, созданное где-либо в приложении, не перехвачено до того, как оно достигнет цикла событий. Если обнаружено неперехваченное исключение, приложение немедленно выйдет из строя, но вы можете добавить обработчик этого события, чтобы переопределить это поведение. Действительно, многие люди используют это как крайний способ поглотить ошибку, чтобы приложение могло продолжать работать, как будто ничего не произошло:

// unsafe
process.on('uncaughtException', (err) => {
  console.error(err);
});

Однако это неправильное использование этого события, поскольку наличие необработанного исключения указывает на то, что приложение находится в неопределенном состоянии. Таким образом, попытка нормального возобновления работы без восстановления после ошибки считается небезопасной и может привести к дальнейшим проблемам, таким как утечка памяти и зависание сокетов. Надлежащее использование обработчика uncaughtException заключается в очистке всех выделенных ресурсов, закрытии соединений и регистрации ошибки для последующей оценки перед выходом из процесса.

// better
process.on('uncaughtException', (err) => {
  Honeybadger.notify(error); // log the error in a permanent storage
  // attempt a gracefully shutdown
  server.close(() => {
    process.exit(1); // then exit
  });

  // If a graceful shutdown is not achieved after 1 second,
  // shut down the process completely
  setTimeout(() => {
    process.abort(); // exit immediately and generate a core dump file
  }, 1000).unref()
});

Точно так же событие unhandledRejection генерируется, когда отклоненное обещание не обрабатывается блоком catch. В отличие от uncaughtException, эти события не вызывают немедленного сбоя приложения. Однако необработанные отказы от промисов устарели и могут немедленно прервать процесс в будущем выпуске Node.js. Вы можете отслеживать необработанные отказы обещаний через обработчик событий unhandledRejection, как показано ниже:

process.on('unhandledRejection', (reason, promise) => {
  Honeybadger.notify({
    message: 'Unhandled promise rejection',
    params: {
      promise,
      reason,
    },
  });
  server.close(() => {
    process.exit(1);
  });

  setTimeout(() => {
    process.abort();
  }, 1000).unref()
});

Вы всегда должны запускать свои серверы с помощью диспетчера процессов, который автоматически перезапустит их в случае сбоя. Распространенным является PM2, но у вас также есть systemd или upstart в Linux, и пользователи Docker могут использовать его политику перезапуска. Как только это будет сделано, надежный сервис будет восстановлен почти мгновенно, и вы по-прежнему будете иметь сведения о неперехваченном исключении, чтобы его можно было быстро исследовать и исправить. Вы можете пойти дальше, запустив более одного процесса и используя балансировщик нагрузки для распределения входящих запросов. Это поможет предотвратить простои в случае временной потери одного из экземпляров.

Централизованная отчетность об ошибках

Ни одна стратегия обработки ошибок не будет полной без надежной стратегии ведения журнала для вашего работающего приложения. Когда происходит сбой, важно выяснить, почему он произошел, записав как можно больше информации о проблеме. Централизация этих журналов позволяет легко получить полную информацию о вашем приложении. Вы сможете сортировать и фильтровать свои ошибки, просматривать основные проблемы и подписываться на оповещения, чтобы получать уведомления о новых ошибках.

Honeybadger предоставляет все необходимое для отслеживания ошибок, возникающих в вашем рабочем приложении. Выполните следующие шаги, чтобы интегрировать его в свое приложение Node.js:

1. Установите пакет

Используйте npm для установки пакета:

$ npm install @honeybadger-io/js --save

2. Импортируйте библиотеку

Импортируйте библиотеку и настройте ее с помощью своего ключа API, чтобы начать сообщать об ошибках:

const Honeybadger = require('@honeybadger-io/js');
Honeybadger.configure({
  apiKey: '[ YOUR API KEY HERE ]'
});

3. Сообщите об ошибках

Вы можете сообщить об ошибке, вызвав метод notify(), как показано в следующем примере:

try {
  // ...error producing code
} catch(error) {
  Honeybadger.notify(error);
}

Для получения дополнительной информации о том, как Honeybadger интегрируется с веб-фреймворками Node.js, см. полную документацию или ознакомьтесь с образцом приложения Node.js/Express на GitHub.

Резюме

Класс (или подкласс) Error всегда должен быть использован для связи ошибок в коде. Технически, вы можете throw что угодно в JavaScript, а не только объекты Error, но это не рекомендуется, так как это значительно снижает полезность ошибки и делает обработку ошибок подверженной ошибкам. Последовательно используя объекты Error, вы можете надежно рассчитывать на доступ error.message или error.stack в местах, где ошибки обрабатываются или регистрируются. Вы даже можете дополнить класс ошибок другими полезными свойствами, относящимися к контексту, в котором произошла ошибка.

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

Ошибки программиста нельзя обработать или исправить, но их можно смягчить с помощью набора автоматизированных тестов и инструментов статической типизации. При написании функции определите поведение для неверных параметров и действуйте соответствующим образом после их обнаружения. Разрешите сбой программы при обнаружении uncaughtException или unhandledRejection. Не пытайтесь исправить такие ошибки!

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

Вывод

Правильная обработка ошибок является непреложным требованием, если вы хотите писать хорошее и надежное программное обеспечение. Используя методы, описанные в этой статье, вы будете на правильном пути к этому.

Спасибо за чтение и удачного кодирования!

Источник

Applications running in Node.js will generally experience four categories of
errors:

Standard JavaScript errors such as {EvalError}, {SyntaxError}, {RangeError},
{ReferenceError}, {TypeError}, and {URIError}.
System errors triggered by underlying operating system constraints such
as attempting to open a file that does not exist or attempting to send data
over a closed socket.
User-specified errors triggered by application code.
AssertionErrors are a special class of error that can be triggered when
Node.js detects an exceptional logic violation that should never occur. These
are raised typically by the node:assert module.

All JavaScript and system errors raised by Node.js inherit from, or are
instances of, the standard JavaScript {Error} class and are guaranteed
to provide at least the properties available on that class.

Error propagation and interception

Node.js supports several mechanisms for propagating and handling errors that
occur while an application is running. How these errors are reported and
handled depends entirely on the type of Error and the style of the API that is
called.

All JavaScript errors are handled as exceptions that immediately generate
and throw an error using the standard JavaScript throw mechanism. These
are handled using the try…catch construct provided by the
JavaScript language.

// Throws with a ReferenceError because z is not defined.
try {
  const m = 1;
  const n = m + z;
} catch (err) {
  // Handle the error here.
}

Any use of the JavaScript throw mechanism will raise an exception that
must be handled using try…catch or the Node.js process will exit
immediately.

With few exceptions, Synchronous APIs (any blocking method that does not
accept a callback function, such as fs.readFileSync), will use throw
to report errors.

Errors that occur within Asynchronous APIs may be reported in multiple ways:

Most asynchronous methods that accept a callback function will accept an
Error object passed as the first argument to that function. If that first
argument is not null and is an instance of Error, then an error occurred
that should be handled.

const fs = require('node:fs');
fs.readFile('a file that does not exist', (err, data) => {
  if (err) {
    console.error('There was an error reading the file!', err);
    return;
  }
  // Otherwise handle the data
});

When an asynchronous method is called on an object that is an
EventEmitter, errors can be routed to that object’s 'error' event.

const net = require('node:net');
const connection = net.connect('localhost');

// Adding an 'error' event handler to a stream:
connection.on('error', (err) => {
  // If the connection is reset by the server, or if it can't
  // connect at all, or on any sort of error encountered by
  // the connection, the error will be sent here.
  console.error(err);
});

connection.pipe(process.stdout);

A handful of typically asynchronous methods in the Node.js API may still
use the throw mechanism to raise exceptions that must be handled using
try…catch. There is no comprehensive list of such methods; please
refer to the documentation of each method to determine the appropriate
error handling mechanism required.

The use of the 'error' event mechanism is most common for stream-based
and event emitter-based APIs, which themselves represent a series of
asynchronous operations over time (as opposed to a single operation that may
pass or fail).

For all EventEmitter objects, if an 'error' event handler is not
provided, the error will be thrown, causing the Node.js process to report an
uncaught exception and crash unless either: The domain module is
used appropriately or a handler has been registered for the
'uncaughtException' event.

const EventEmitter = require('node:events');
const ee = new EventEmitter();

setImmediate(() => {
  // This will crash the process because no 'error' event
  // handler has been added.
  ee.emit('error', new Error('This will crash'));
});

Errors generated in this way cannot be intercepted using try…catch as
they are thrown after the calling code has already exited.

Developers must refer to the documentation for each method to determine
exactly how errors raised by those methods are propagated.

Error-first callbacks

Most asynchronous methods exposed by the Node.js core API follow an idiomatic
pattern referred to as an error-first callback. With this pattern, a callback
function is passed to the method as an argument. When the operation either
completes or an error is raised, the callback function is called with the
Error object (if any) passed as the first argument. If no error was raised,
the first argument will be passed as null.

const fs = require('node:fs');

function errorFirstCallback(err, data) {
  if (err) {
    console.error('There was an error', err);
    return;
  }
  console.log(data);
}

fs.readFile('/some/file/that/does-not-exist', errorFirstCallback);
fs.readFile('/some/file/that/does-exist', errorFirstCallback);

The JavaScript try…catch mechanism cannot be used to intercept errors
generated by asynchronous APIs. A common mistake for beginners is to try to
use throw inside an error-first callback:

// THIS WILL NOT WORK:
const fs = require('node:fs');

try {
  fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    // Mistaken assumption: throwing here...
    if (err) {
      throw err;
    }
  });
} catch (err) {
  // This will not catch the throw!
  console.error(err);
}

This will not work because the callback function passed to fs.readFile() is
called asynchronously. By the time the callback has been called, the
surrounding code, including the try…catch block, will have already exited.
Throwing an error inside the callback can crash the Node.js process in most
cases. If domains are enabled, or a handler has been registered with
process.on('uncaughtException'), such errors can be intercepted.

Class: `Error`

A generic JavaScript {Error} object that does not denote any specific
circumstance of why the error occurred. Error objects capture a «stack trace»
detailing the point in the code at which the Error was instantiated, and may
provide a text description of the error.

All errors generated by Node.js, including all system and JavaScript errors,
will either be instances of, or inherit from, the Error class.

`new Error(message[, options])`

message {string}
options {Object}
- cause {any} The error that caused the newly created error.

Creates a new Error object and sets the error.message property to the
provided text message. If an object is passed as message, the text message
is generated by calling String(message). If the cause option is provided,
it is assigned to the error.cause property. The error.stack property will
represent the point in the code at which new Error() was called. Stack traces
are dependent on V8’s stack trace API. Stack traces extend only to either
(a) the beginning of synchronous code execution, or (b) the number of frames
given by the property Error.stackTraceLimit, whichever is smaller.

`Error.captureStackTrace(targetObject[, constructorOpt])`

targetObject {Object}
constructorOpt {Function}

Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.

The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:

function MyError() {
  Error.captureStackTrace(this, MyError);
}

// Without passing MyError to captureStackTrace, the MyError
// frame would show up in the .stack property. By passing
// the constructor, we omit that frame, and retain all frames below it.
new MyError().stack;

`Error.stackTraceLimit`

{number}

The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

`error.cause`

{any}

If present, the error.cause property is the underlying cause of the Error.
It is used when catching an error and throwing a new one with a different
message or code in order to still have access to the original error.

The error.cause property is typically set by calling
new Error(message, { cause }). It is not set by the constructor if the
cause option is not provided.

This property allows errors to be chained. When serializing Error objects,
util.inspect() recursively serializes error.cause if it is set.

const cause = new Error('The remote HTTP server responded with a 500 status');
const symptom = new Error('The message failed to send', { cause });

console.log(symptom);
// Prints:
//   Error: The message failed to send
//       at REPL2:1:17
//       at Script.runInThisContext (node:vm:130:12)
//       ... 7 lines matching cause stack trace ...
//       at [_line] [as _line] (node:internal/readline/interface:886:18) {
//     [cause]: Error: The remote HTTP server responded with a 500 status
//         at REPL1:1:15
//         at Script.runInThisContext (node:vm:130:12)
//         at REPLServer.defaultEval (node:repl:574:29)
//         at bound (node:domain:426:15)
//         at REPLServer.runBound [as eval] (node:domain:437:12)
//         at REPLServer.onLine (node:repl:902:10)
//         at REPLServer.emit (node:events:549:35)
//         at REPLServer.emit (node:domain:482:12)
//         at [_onLine] [as _onLine] (node:internal/readline/interface:425:12)
//         at [_line] [as _line] (node:internal/readline/interface:886:18)

`error.code`

{string}

The error.code property is a string label that identifies the kind of error.
error.code is the most stable way to identify an error. It will only change
between major versions of Node.js. In contrast, error.message strings may
change between any versions of Node.js. See Node.js error codes for details
about specific codes.

`error.message`

{string}

The error.message property is the string description of the error as set by
calling new Error(message). The message passed to the constructor will also
appear in the first line of the stack trace of the Error, however changing
this property after the Error object is created may not change the first
line of the stack trace (for example, when error.stack is read before this
property is changed).

const err = new Error('The message');
console.error(err.message);
// Prints: The message

`error.stack`

{string}

The error.stack property is a string describing the point in the code at which
the Error was instantiated.

Error: Things keep happening!
   at /home/gbusey/file.js:525:2
   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)
   at increaseSynergy (/home/gbusey/actors.js:701:6)

The first line is formatted as <error class name>: <error message>, and
is followed by a series of stack frames (each line beginning with «at «).
Each frame describes a call site within the code that lead to the error being
generated. V8 attempts to display a name for each function (by variable name,
function name, or object method name), but occasionally it will not be able to
find a suitable name. If V8 cannot determine a name for the function, only
location information will be displayed for that frame. Otherwise, the
determined function name will be displayed with location information appended
in parentheses.

Frames are only generated for JavaScript functions. If, for example, execution
synchronously passes through a C++ addon function called cheetahify which
itself calls a JavaScript function, the frame representing the cheetahify call
will not be present in the stack traces:

const cheetahify = require('./native-binding.node');

function makeFaster() {
  // `cheetahify()` *synchronously* calls speedy.
  cheetahify(function speedy() {
    throw new Error('oh no!');
  });
}

makeFaster();
// will throw:
//   /home/gbusey/file.js:6
//       throw new Error('oh no!');
//           ^
//   Error: oh no!
//       at speedy (/home/gbusey/file.js:6:11)
//       at makeFaster (/home/gbusey/file.js:5:3)
//       at Object.<anonymous> (/home/gbusey/file.js:10:1)
//       at Module._compile (module.js:456:26)
//       at Object.Module._extensions..js (module.js:474:10)
//       at Module.load (module.js:356:32)
//       at Function.Module._load (module.js:312:12)
//       at Function.Module.runMain (module.js:497:10)
//       at startup (node.js:119:16)
//       at node.js:906:3

The location information will be one of:

native, if the frame represents a call internal to V8 (as in [].forEach).
plain-filename.js:line:column, if the frame represents a call internal
to Node.js.
/absolute/path/to/file.js:line:column, if the frame represents a call in
a user program (using CommonJS module system), or its dependencies.
<transport-protocol>:///url/to/module/file.mjs:line:column, if the frame
represents a call in a user program (using ES module system), or
its dependencies.

The string representing the stack trace is lazily generated when the
error.stack property is accessed.

The number of frames captured by the stack trace is bounded by the smaller of
Error.stackTraceLimit or the number of available frames on the current event
loop tick.

Class: `AssertionError`

Extends: {errors.Error}

Indicates the failure of an assertion. For details, see
Class: assert.AssertionError.

Class: `RangeError`

Extends: {errors.Error}

Indicates that a provided argument was not within the set or range of
acceptable values for a function; whether that is a numeric range, or
outside the set of options for a given function parameter.

require('node:net').connect(-1);
// Throws "RangeError: "port" option should be >= 0 and < 65536: -1"

Node.js will generate and throw RangeError instances immediately as a form
of argument validation.

Class: `ReferenceError`

Extends: {errors.Error}

Indicates that an attempt is being made to access a variable that is not
defined. Such errors commonly indicate typos in code, or an otherwise broken
program.

While client code may generate and propagate these errors, in practice, only V8
will do so.

doesNotExist;
// Throws ReferenceError, doesNotExist is not a variable in this program.

Unless an application is dynamically generating and running code,
ReferenceError instances indicate a bug in the code or its dependencies.

Class: `SyntaxError`

Extends: {errors.Error}

Indicates that a program is not valid JavaScript. These errors may only be
generated and propagated as a result of code evaluation. Code evaluation may
happen as a result of eval, Function, require, or vm. These errors
are almost always indicative of a broken program.

try {
  require('node:vm').runInThisContext('binary ! isNotOk');
} catch (err) {
  // 'err' will be a SyntaxError.
}

SyntaxError instances are unrecoverable in the context that created them –
they may only be caught by other contexts.

Class: `SystemError`

Extends: {errors.Error}

Node.js generates system errors when exceptions occur within its runtime
environment. These usually occur when an application violates an operating
system constraint. For example, a system error will occur if an application
attempts to read a file that does not exist.

address {string} If present, the address to which a network connection
failed
code {string} The string error code
dest {string} If present, the file path destination when reporting a file
system error
errno {number} The system-provided error number
info {Object} If present, extra details about the error condition
message {string} A system-provided human-readable description of the error
path {string} If present, the file path when reporting a file system error
port {number} If present, the network connection port that is not available
syscall {string} The name of the system call that triggered the error

`error.address`

{string}

If present, error.address is a string describing the address to which a
network connection failed.

`error.code`

{string}

The error.code property is a string representing the error code.

`error.dest`

{string}

If present, error.dest is the file path destination when reporting a file
system error.

`error.errno`

{number}

The error.errno property is a negative number which corresponds
to the error code defined in libuv Error handling.

On Windows the error number provided by the system will be normalized by libuv.

To get the string representation of the error code, use
util.getSystemErrorName(error.errno).

`error.info`

{Object}

If present, error.info is an object with details about the error condition.

`error.message`

{string}

error.message is a system-provided human-readable description of the error.

`error.path`

{string}

If present, error.path is a string containing a relevant invalid pathname.

`error.port`

{number}

If present, error.port is the network connection port that is not available.

`error.syscall`

{string}

The error.syscall property is a string describing the syscall that failed.

Common system errors

This is a list of system errors commonly-encountered when writing a Node.js
program. For a comprehensive list, see the errno(3) man page.

EACCES (Permission denied): An attempt was made to access a file in a way
forbidden by its file access permissions.
EADDRINUSE (Address already in use): An attempt to bind a server
(net, http, or https) to a local address failed due to
another server on the local system already occupying that address.
ECONNREFUSED (Connection refused): No connection could be made because the
target machine actively refused it. This usually results from trying to
connect to a service that is inactive on the foreign host.
ECONNRESET (Connection reset by peer): A connection was forcibly closed by
a peer. This normally results from a loss of the connection on the remote
socket due to a timeout or reboot. Commonly encountered via the http
and net modules.
EEXIST (File exists): An existing file was the target of an operation that
required that the target not exist.
EISDIR (Is a directory): An operation expected a file, but the given
pathname was a directory.
EMFILE (Too many open files in system): Maximum number of
file descriptors allowable on the system has been reached, and
requests for another descriptor cannot be fulfilled until at least one
has been closed. This is encountered when opening many files at once in
parallel, especially on systems (in particular, macOS) where there is a low
file descriptor limit for processes. To remedy a low limit, run
ulimit -n 2048 in the same shell that will run the Node.js process.
ENOENT (No such file or directory): Commonly raised by fs operations
to indicate that a component of the specified pathname does not exist. No
entity (file or directory) could be found by the given path.
ENOTDIR (Not a directory): A component of the given pathname existed, but
was not a directory as expected. Commonly raised by fs.readdir.
ENOTEMPTY (Directory not empty): A directory with entries was the target
of an operation that requires an empty directory, usually fs.unlink.
ENOTFOUND (DNS lookup failed): Indicates a DNS failure of either
EAI_NODATA or EAI_NONAME. This is not a standard POSIX error.
EPERM (Operation not permitted): An attempt was made to perform an
operation that requires elevated privileges.
EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is
no process to read the data. Commonly encountered at the net and
http layers, indicative that the remote side of the stream being
written to has been closed.
ETIMEDOUT (Operation timed out): A connect or send request failed because
the connected party did not properly respond after a period of time. Usually
encountered by http or net. Often a sign that a socket.end()
was not properly called.

Class: `TypeError`

Extends {errors.Error}

Indicates that a provided argument is not an allowable type. For example,
passing a function to a parameter which expects a string would be a TypeError.

require('node:url').parse(() => { });
// Throws TypeError, since it expected a string.

Node.js will generate and throw TypeError instances immediately as a form
of argument validation.

Exceptions vs. errors

A JavaScript exception is a value that is thrown as a result of an invalid
operation or as the target of a throw statement. While it is not required
that these values are instances of Error or classes which inherit from
Error, all exceptions thrown by Node.js or the JavaScript runtime will be
instances of Error.

Some exceptions are unrecoverable at the JavaScript layer. Such exceptions
will always cause the Node.js process to crash. Examples include assert()
checks or abort() calls in the C++ layer.

OpenSSL errors

Errors originating in crypto or tls are of class Error, and in addition to
the standard .code and .message properties, may have some additional
OpenSSL-specific properties.

`error.opensslErrorStack`

An array of errors that can give context to where in the OpenSSL library an
error originates from.

`error.function`

The OpenSSL function the error originates in.

`error.library`

The OpenSSL library the error originates in.

`error.reason`

A human-readable string describing the reason for the error.

Node.js error codes

`ABORT_ERR`

Used when an operation has been aborted (typically using an AbortController).

APIs not using AbortSignals typically do not raise an error with this code.

This code does not use the regular ERR_* convention Node.js errors use in
order to be compatible with the web platform’s AbortError.

`ERR_AMBIGUOUS_ARGUMENT`

A function argument is being used in a way that suggests that the function
signature may be misunderstood. This is thrown by the node:assert module when
the message parameter in assert.throws(block, message) matches the error
message thrown by block because that usage suggests that the user believes
message is the expected message rather than the message the AssertionError
will display if block does not throw.

`ERR_ARG_NOT_ITERABLE`

An iterable argument (i.e. a value that works with for...of loops) was
required, but not provided to a Node.js API.

`ERR_ASSERTION`

A special type of error that can be triggered whenever Node.js detects an
exceptional logic violation that should never occur. These are raised typically
by the node:assert module.

`ERR_ASYNC_CALLBACK`

An attempt was made to register something that is not a function as an
AsyncHooks callback.

`ERR_ASYNC_TYPE`

The type of an asynchronous resource was invalid. Users are also able
to define their own types if using the public embedder API.

`ERR_BROTLI_COMPRESSION_FAILED`

Data passed to a Brotli stream was not successfully compressed.

`ERR_BROTLI_INVALID_PARAM`

An invalid parameter key was passed during construction of a Brotli stream.

`ERR_BUFFER_CONTEXT_NOT_AVAILABLE`

An attempt was made to create a Node.js Buffer instance from addon or embedder
code, while in a JS engine Context that is not associated with a Node.js
instance. The data passed to the Buffer method will have been released
by the time the method returns.

When encountering this error, a possible alternative to creating a Buffer
instance is to create a normal Uint8Array, which only differs in the
prototype of the resulting object. Uint8Arrays are generally accepted in all
Node.js core APIs where Buffers are; they are available in all Contexts.

`ERR_BUFFER_OUT_OF_BOUNDS`

An operation outside the bounds of a Buffer was attempted.

`ERR_BUFFER_TOO_LARGE`

An attempt has been made to create a Buffer larger than the maximum allowed
size.

`ERR_CANNOT_WATCH_SIGINT`

Node.js was unable to watch for the SIGINT signal.

`ERR_CHILD_CLOSED_BEFORE_REPLY`

A child process was closed before the parent received a reply.

`ERR_CHILD_PROCESS_IPC_REQUIRED`

Used when a child process is being forked without specifying an IPC channel.

`ERR_CHILD_PROCESS_STDIO_MAXBUFFER`

Used when the main process is trying to read data from the child process’s
STDERR/STDOUT, and the data’s length is longer than the maxBuffer option.

`ERR_CLOSED_MESSAGE_PORT`

There was an attempt to use a MessagePort instance in a closed
state, usually after .close() has been called.

`ERR_CONSOLE_WRITABLE_STREAM`

Console was instantiated without stdout stream, or Console has a
non-writable stdout or stderr stream.

`ERR_CONSTRUCT_CALL_INVALID`

A class constructor was called that is not callable.

`ERR_CONSTRUCT_CALL_REQUIRED`

A constructor for a class was called without new.

`ERR_CONTEXT_NOT_INITIALIZED`

The vm context passed into the API is not yet initialized. This could happen
when an error occurs (and is caught) during the creation of the
context, for example, when the allocation fails or the maximum call stack
size is reached when the context is created.

`ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED`

A client certificate engine was requested that is not supported by the version
of OpenSSL being used.

`ERR_CRYPTO_ECDH_INVALID_FORMAT`

An invalid value for the format argument was passed to the crypto.ECDH()
class getPublicKey() method.

`ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY`

An invalid value for the key argument has been passed to the
crypto.ECDH() class computeSecret() method. It means that the public
key lies outside of the elliptic curve.

`ERR_CRYPTO_ENGINE_UNKNOWN`

An invalid crypto engine identifier was passed to
require('node:crypto').setEngine().

`ERR_CRYPTO_FIPS_FORCED`

The --force-fips command-line argument was used but there was an attempt
to enable or disable FIPS mode in the node:crypto module.

`ERR_CRYPTO_FIPS_UNAVAILABLE`

An attempt was made to enable or disable FIPS mode, but FIPS mode was not
available.

`ERR_CRYPTO_HASH_FINALIZED`

hash.digest() was called multiple times. The hash.digest() method must
be called no more than one time per instance of a Hash object.

`ERR_CRYPTO_HASH_UPDATE_FAILED`

hash.update() failed for any reason. This should rarely, if ever, happen.

`ERR_CRYPTO_INCOMPATIBLE_KEY`

The given crypto keys are incompatible with the attempted operation.

`ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS`

The selected public or private key encoding is incompatible with other options.

`ERR_CRYPTO_INITIALIZATION_FAILED`

Initialization of the crypto subsystem failed.

`ERR_CRYPTO_INVALID_AUTH_TAG`

An invalid authentication tag was provided.

`ERR_CRYPTO_INVALID_COUNTER`

An invalid counter was provided for a counter-mode cipher.

`ERR_CRYPTO_INVALID_CURVE`

An invalid elliptic-curve was provided.

`ERR_CRYPTO_INVALID_DIGEST`

An invalid crypto digest algorithm was specified.

`ERR_CRYPTO_INVALID_IV`

An invalid initialization vector was provided.

`ERR_CRYPTO_INVALID_JWK`

An invalid JSON Web Key was provided.

`ERR_CRYPTO_INVALID_KEY_OBJECT_TYPE`

The given crypto key object’s type is invalid for the attempted operation.

`ERR_CRYPTO_INVALID_KEYLEN`

An invalid key length was provided.

`ERR_CRYPTO_INVALID_KEYPAIR`

An invalid key pair was provided.

`ERR_CRYPTO_INVALID_KEYTYPE`

An invalid key type was provided.

`ERR_CRYPTO_INVALID_MESSAGELEN`

An invalid message length was provided.

`ERR_CRYPTO_INVALID_SCRYPT_PARAMS`

Invalid scrypt algorithm parameters were provided.

`ERR_CRYPTO_INVALID_STATE`

A crypto method was used on an object that was in an invalid state. For
instance, calling cipher.getAuthTag() before calling cipher.final().

`ERR_CRYPTO_INVALID_TAG_LENGTH`

An invalid authentication tag length was provided.

`ERR_CRYPTO_JOB_INIT_FAILED`

Initialization of an asynchronous crypto operation failed.

`ERR_CRYPTO_JWK_UNSUPPORTED_CURVE`

Key’s Elliptic Curve is not registered for use in the
JSON Web Key Elliptic Curve Registry.

`ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE`

Key’s Asymmetric Key Type is not registered for use in the
JSON Web Key Types Registry.

`ERR_CRYPTO_OPERATION_FAILED`

A crypto operation failed for an otherwise unspecified reason.

`ERR_CRYPTO_PBKDF2_ERROR`

The PBKDF2 algorithm failed for unspecified reasons. OpenSSL does not provide
more details and therefore neither does Node.js.

`ERR_CRYPTO_SCRYPT_INVALID_PARAMETER`

One or more crypto.scrypt() or crypto.scryptSync() parameters are
outside their legal range.

`ERR_CRYPTO_SCRYPT_NOT_SUPPORTED`

Node.js was compiled without scrypt support. Not possible with the official
release binaries but can happen with custom builds, including distro builds.

`ERR_CRYPTO_SIGN_KEY_REQUIRED`

A signing key was not provided to the sign.sign() method.

`ERR_CRYPTO_TIMING_SAFE_EQUAL_LENGTH`

crypto.timingSafeEqual() was called with Buffer, TypedArray, or
DataView arguments of different lengths.

`ERR_CRYPTO_UNKNOWN_CIPHER`

An unknown cipher was specified.

`ERR_CRYPTO_UNKNOWN_DH_GROUP`

An unknown Diffie-Hellman group name was given. See
crypto.getDiffieHellman() for a list of valid group names.

`ERR_CRYPTO_UNSUPPORTED_OPERATION`

An attempt to invoke an unsupported crypto operation was made.

`ERR_DEBUGGER_ERROR`

An error occurred with the debugger.

`ERR_DEBUGGER_STARTUP_ERROR`

The debugger timed out waiting for the required host/port to be free.

`ERR_DLOPEN_DISABLED`

Loading native addons has been disabled using --no-addons.

`ERR_DLOPEN_FAILED`

A call to process.dlopen() failed.

`ERR_DIR_CLOSED`

The fs.Dir was previously closed.

`ERR_DIR_CONCURRENT_OPERATION`

A synchronous read or close call was attempted on an fs.Dir which has
ongoing asynchronous operations.

`ERR_DNS_SET_SERVERS_FAILED`

c-ares failed to set the DNS server.

`ERR_DOMAIN_CALLBACK_NOT_AVAILABLE`

The node:domain module was not usable since it could not establish the
required error handling hooks, because
process.setUncaughtExceptionCaptureCallback() had been called at an
earlier point in time.

`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`

process.setUncaughtExceptionCaptureCallback() could not be called
because the node:domain module has been loaded at an earlier point in time.

The stack trace is extended to include the point in time at which the
node:domain module had been loaded.

`ERR_DUPLICATE_STARTUP_SNAPSHOT_MAIN_FUNCTION`

v8.startupSnapshot.setDeserializeMainFunction() could not be called
because it had already been called before.

`ERR_ENCODING_INVALID_ENCODED_DATA`

Data provided to TextDecoder() API was invalid according to the encoding
provided.

`ERR_ENCODING_NOT_SUPPORTED`

Encoding provided to TextDecoder() API was not one of the
WHATWG Supported Encodings.

`ERR_EVAL_ESM_CANNOT_PRINT`

--print cannot be used with ESM input.

`ERR_EVENT_RECURSION`

Thrown when an attempt is made to recursively dispatch an event on EventTarget.

`ERR_EXECUTION_ENVIRONMENT_NOT_AVAILABLE`

The JS execution context is not associated with a Node.js environment.
This may occur when Node.js is used as an embedded library and some hooks
for the JS engine are not set up properly.

`ERR_FALSY_VALUE_REJECTION`

A Promise that was callbackified via util.callbackify() was rejected with a
falsy value.

`ERR_FEATURE_UNAVAILABLE_ON_PLATFORM`

Used when a feature that is not available
to the current platform which is running Node.js is used.

`ERR_FS_CP_DIR_TO_NON_DIR`

An attempt was made to copy a directory to a non-directory (file, symlink,
etc.) using fs.cp().

`ERR_FS_CP_EEXIST`

An attempt was made to copy over a file that already existed with
fs.cp(), with the force and errorOnExist set to true.

`ERR_FS_CP_EINVAL`

When using fs.cp(), src or dest pointed to an invalid path.

`ERR_HTTP_CONTENT_LENGTH_MISMATCH`

Response body size doesn’t match with the specified content-length header value.

`ERR_FS_CP_FIFO_PIPE`

An attempt was made to copy a named pipe with fs.cp().

`ERR_FS_CP_NON_DIR_TO_DIR`

An attempt was made to copy a non-directory (file, symlink, etc.) to a directory
using fs.cp().

`ERR_FS_CP_SOCKET`

An attempt was made to copy to a socket with fs.cp().

`ERR_FS_CP_SYMLINK_TO_SUBDIRECTORY`

When using fs.cp(), a symlink in dest pointed to a subdirectory
of src.

`ERR_FS_CP_UNKNOWN`

An attempt was made to copy to an unknown file type with fs.cp().

`ERR_FS_EISDIR`

Path is a directory.

`ERR_FS_FILE_TOO_LARGE`

An attempt has been made to read a file whose size is larger than the maximum
allowed size for a Buffer.

`ERR_FS_INVALID_SYMLINK_TYPE`

An invalid symlink type was passed to the fs.symlink() or
fs.symlinkSync() methods.

`ERR_HTTP_HEADERS_SENT`

An attempt was made to add more headers after the headers had already been sent.

`ERR_HTTP_INVALID_HEADER_VALUE`

An invalid HTTP header value was specified.

`ERR_HTTP_INVALID_STATUS_CODE`

Status code was outside the regular status code range (100-999).

`ERR_HTTP_REQUEST_TIMEOUT`

The client has not sent the entire request within the allowed time.

`ERR_HTTP_SOCKET_ENCODING`

Changing the socket encoding is not allowed per RFC 7230 Section 3.

`ERR_HTTP_TRAILER_INVALID`

The Trailer header was set even though the transfer encoding does not support
that.

`ERR_HTTP2_ALTSVC_INVALID_ORIGIN`

HTTP/2 ALTSVC frames require a valid origin.

`ERR_HTTP2_ALTSVC_LENGTH`

HTTP/2 ALTSVC frames are limited to a maximum of 16,382 payload bytes.

`ERR_HTTP2_CONNECT_AUTHORITY`

For HTTP/2 requests using the CONNECT method, the :authority pseudo-header
is required.

`ERR_HTTP2_CONNECT_PATH`

For HTTP/2 requests using the CONNECT method, the :path pseudo-header is
forbidden.

`ERR_HTTP2_CONNECT_SCHEME`

For HTTP/2 requests using the CONNECT method, the :scheme pseudo-header is
forbidden.

`ERR_HTTP2_ERROR`

A non-specific HTTP/2 error has occurred.

`ERR_HTTP2_GOAWAY_SESSION`

New HTTP/2 Streams may not be opened after the Http2Session has received a
GOAWAY frame from the connected peer.

`ERR_HTTP2_HEADER_SINGLE_VALUE`

Multiple values were provided for an HTTP/2 header field that was required to
have only a single value.

`ERR_HTTP2_HEADERS_AFTER_RESPOND`

An additional headers was specified after an HTTP/2 response was initiated.

`ERR_HTTP2_HEADERS_SENT`

An attempt was made to send multiple response headers.

`ERR_HTTP2_INFO_STATUS_NOT_ALLOWED`

Informational HTTP status codes (1xx) may not be set as the response status
code on HTTP/2 responses.

`ERR_HTTP2_INVALID_CONNECTION_HEADERS`

HTTP/1 connection specific headers are forbidden to be used in HTTP/2
requests and responses.

`ERR_HTTP2_INVALID_HEADER_VALUE`

An invalid HTTP/2 header value was specified.

`ERR_HTTP2_INVALID_INFO_STATUS`

An invalid HTTP informational status code has been specified. Informational
status codes must be an integer between 100 and 199 (inclusive).

`ERR_HTTP2_INVALID_ORIGIN`

HTTP/2 ORIGIN frames require a valid origin.

`ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH`

Input Buffer and Uint8Array instances passed to the
http2.getUnpackedSettings() API must have a length that is a multiple of
six.

`ERR_HTTP2_INVALID_PSEUDOHEADER`

Only valid HTTP/2 pseudoheaders (:status, :path, :authority, :scheme,
and :method) may be used.

`ERR_HTTP2_INVALID_SESSION`

An action was performed on an Http2Session object that had already been
destroyed.

`ERR_HTTP2_INVALID_SETTING_VALUE`

An invalid value has been specified for an HTTP/2 setting.

`ERR_HTTP2_INVALID_STREAM`

An operation was performed on a stream that had already been destroyed.

`ERR_HTTP2_MAX_PENDING_SETTINGS_ACK`

Whenever an HTTP/2 SETTINGS frame is sent to a connected peer, the peer is
required to send an acknowledgment that it has received and applied the new
SETTINGS. By default, a maximum number of unacknowledged SETTINGS frames may
be sent at any given time. This error code is used when that limit has been
reached.

`ERR_HTTP2_NESTED_PUSH`

An attempt was made to initiate a new push stream from within a push stream.
Nested push streams are not permitted.

`ERR_HTTP2_NO_MEM`

Out of memory when using the http2session.setLocalWindowSize(windowSize) API.

`ERR_HTTP2_NO_SOCKET_MANIPULATION`

An attempt was made to directly manipulate (read, write, pause, resume, etc.) a
socket attached to an Http2Session.

`ERR_HTTP2_ORIGIN_LENGTH`

HTTP/2 ORIGIN frames are limited to a length of 16382 bytes.

`ERR_HTTP2_OUT_OF_STREAMS`

The number of streams created on a single HTTP/2 session reached the maximum
limit.

`ERR_HTTP2_PAYLOAD_FORBIDDEN`

A message payload was specified for an HTTP response code for which a payload is
forbidden.

`ERR_HTTP2_PING_CANCEL`

An HTTP/2 ping was canceled.

`ERR_HTTP2_PING_LENGTH`

HTTP/2 ping payloads must be exactly 8 bytes in length.

`ERR_HTTP2_PSEUDOHEADER_NOT_ALLOWED`

An HTTP/2 pseudo-header has been used inappropriately. Pseudo-headers are header
key names that begin with the : prefix.

`ERR_HTTP2_PUSH_DISABLED`

An attempt was made to create a push stream, which had been disabled by the
client.

`ERR_HTTP2_SEND_FILE`

An attempt was made to use the Http2Stream.prototype.responseWithFile() API to
send a directory.

`ERR_HTTP2_SEND_FILE_NOSEEK`

An attempt was made to use the Http2Stream.prototype.responseWithFile() API to
send something other than a regular file, but offset or length options were
provided.

`ERR_HTTP2_SESSION_ERROR`

The Http2Session closed with a non-zero error code.

`ERR_HTTP2_SETTINGS_CANCEL`

The Http2Session settings canceled.

`ERR_HTTP2_SOCKET_BOUND`

An attempt was made to connect a Http2Session object to a net.Socket or
tls.TLSSocket that had already been bound to another Http2Session object.

`ERR_HTTP2_SOCKET_UNBOUND`

An attempt was made to use the socket property of an Http2Session that
has already been closed.

`ERR_HTTP2_STATUS_101`

Use of the 101 Informational status code is forbidden in HTTP/2.

`ERR_HTTP2_STATUS_INVALID`

An invalid HTTP status code has been specified. Status codes must be an integer
between 100 and 599 (inclusive).

`ERR_HTTP2_STREAM_CANCEL`

An Http2Stream was destroyed before any data was transmitted to the connected
peer.

`ERR_HTTP2_STREAM_ERROR`

A non-zero error code was been specified in an RST_STREAM frame.

`ERR_HTTP2_STREAM_SELF_DEPENDENCY`

When setting the priority for an HTTP/2 stream, the stream may be marked as
a dependency for a parent stream. This error code is used when an attempt is
made to mark a stream and dependent of itself.

`ERR_HTTP2_TOO_MANY_INVALID_FRAMES`

The limit of acceptable invalid HTTP/2 protocol frames sent by the peer,
as specified through the maxSessionInvalidFrames option, has been exceeded.

`ERR_HTTP2_TRAILERS_ALREADY_SENT`

Trailing headers have already been sent on the Http2Stream.

`ERR_HTTP2_TRAILERS_NOT_READY`

The http2stream.sendTrailers() method cannot be called until after the
'wantTrailers' event is emitted on an Http2Stream object. The
'wantTrailers' event will only be emitted if the waitForTrailers option
is set for the Http2Stream.

`ERR_HTTP2_UNSUPPORTED_PROTOCOL`

http2.connect() was passed a URL that uses any protocol other than http: or
https:.

`ERR_ILLEGAL_CONSTRUCTOR`

An attempt was made to construct an object using a non-public constructor.

`ERR_IMPORT_ASSERTION_TYPE_FAILED`

An import assertion has failed, preventing the specified module to be imported.

`ERR_IMPORT_ASSERTION_TYPE_MISSING`

An import assertion is missing, preventing the specified module to be imported.

`ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED`

An import assertion is not supported by this version of Node.js.

`ERR_INCOMPATIBLE_OPTION_PAIR`

An option pair is incompatible with each other and cannot be used at the same
time.

`ERR_INPUT_TYPE_NOT_ALLOWED`

Stability: 1 — Experimental

The --input-type flag was used to attempt to execute a file. This flag can
only be used with input via --eval, --print, or STDIN.

`ERR_INSPECTOR_ALREADY_ACTIVATED`

While using the node:inspector module, an attempt was made to activate the
inspector when it already started to listen on a port. Use inspector.close()
before activating it on a different address.

`ERR_INSPECTOR_ALREADY_CONNECTED`

While using the node:inspector module, an attempt was made to connect when the
inspector was already connected.

`ERR_INSPECTOR_CLOSED`

While using the node:inspector module, an attempt was made to use the
inspector after the session had already closed.

`ERR_INSPECTOR_COMMAND`

An error occurred while issuing a command via the node:inspector module.

`ERR_INSPECTOR_NOT_ACTIVE`

The inspector is not active when inspector.waitForDebugger() is called.

`ERR_INSPECTOR_NOT_AVAILABLE`

The node:inspector module is not available for use.

`ERR_INSPECTOR_NOT_CONNECTED`

While using the node:inspector module, an attempt was made to use the
inspector before it was connected.

`ERR_INSPECTOR_NOT_WORKER`

An API was called on the main thread that can only be used from
the worker thread.

`ERR_INTERNAL_ASSERTION`

There was a bug in Node.js or incorrect usage of Node.js internals.
To fix the error, open an issue at https://github.com/nodejs/node/issues.

`ERR_INVALID_ADDRESS_FAMILY`

The provided address family is not understood by the Node.js API.

`ERR_INVALID_ARG_TYPE`

An argument of the wrong type was passed to a Node.js API.

`ERR_INVALID_ARG_VALUE`

An invalid or unsupported value was passed for a given argument.

`ERR_INVALID_ASYNC_ID`

An invalid asyncId or triggerAsyncId was passed using AsyncHooks. An id
less than -1 should never happen.

`ERR_INVALID_BUFFER_SIZE`

A swap was performed on a Buffer but its size was not compatible with the
operation.

`ERR_INVALID_CHAR`

Invalid characters were detected in headers.

`ERR_INVALID_CURSOR_POS`

A cursor on a given stream cannot be moved to a specified row without a
specified column.

`ERR_INVALID_FD`

A file descriptor (‘fd’) was not valid (e.g. it was a negative value).

`ERR_INVALID_FD_TYPE`

A file descriptor (‘fd’) type was not valid.

`ERR_INVALID_FILE_URL_HOST`

A Node.js API that consumes file: URLs (such as certain functions in the
fs module) encountered a file URL with an incompatible host. This
situation can only occur on Unix-like systems where only localhost or an empty
host is supported.

`ERR_INVALID_FILE_URL_PATH`

A Node.js API that consumes file: URLs (such as certain functions in the
fs module) encountered a file URL with an incompatible path. The exact
semantics for determining whether a path can be used is platform-dependent.

`ERR_INVALID_HANDLE_TYPE`

An attempt was made to send an unsupported «handle» over an IPC communication
channel to a child process. See subprocess.send() and process.send()
for more information.

`ERR_INVALID_HTTP_TOKEN`

An invalid HTTP token was supplied.

`ERR_INVALID_IP_ADDRESS`

An IP address is not valid.

`ERR_INVALID_MIME_SYNTAX`

The syntax of a MIME is not valid.

`ERR_INVALID_MODULE`

An attempt was made to load a module that does not exist or was otherwise not
valid.

`ERR_INVALID_MODULE_SPECIFIER`

The imported module string is an invalid URL, package name, or package subpath
specifier.

`ERR_INVALID_OBJECT_DEFINE_PROPERTY`

An error occurred while setting an invalid attribute on the property of
an object.

`ERR_INVALID_PACKAGE_CONFIG`

An invalid package.json file failed parsing.

`ERR_INVALID_PACKAGE_TARGET`

The package.json "exports" field contains an invalid target mapping
value for the attempted module resolution.

`ERR_INVALID_PERFORMANCE_MARK`

While using the Performance Timing API (perf_hooks), a performance mark is
invalid.

`ERR_INVALID_PROTOCOL`

An invalid options.protocol was passed to http.request().

`ERR_INVALID_REPL_EVAL_CONFIG`

Both breakEvalOnSigint and eval options were set in the REPL config,
which is not supported.

`ERR_INVALID_REPL_INPUT`

The input may not be used in the REPL. The conditions under which this
error is used are described in the REPL documentation.

`ERR_INVALID_RETURN_PROPERTY`

Thrown in case a function option does not provide a valid value for one of its
returned object properties on execution.

`ERR_INVALID_RETURN_PROPERTY_VALUE`

Thrown in case a function option does not provide an expected value
type for one of its returned object properties on execution.

`ERR_INVALID_RETURN_VALUE`

Thrown in case a function option does not return an expected value
type on execution, such as when a function is expected to return a promise.

`ERR_INVALID_STATE`

Indicates that an operation cannot be completed due to an invalid state.
For instance, an object may have already been destroyed, or may be
performing another operation.

`ERR_INVALID_SYNC_FORK_INPUT`

A Buffer, TypedArray, DataView, or string was provided as stdio input to
an asynchronous fork. See the documentation for the child_process module
for more information.

`ERR_INVALID_THIS`

A Node.js API function was called with an incompatible this value.

const urlSearchParams = new URLSearchParams('foo=bar&baz=new');

const buf = Buffer.alloc(1);
urlSearchParams.has.call(buf, 'foo');
// Throws a TypeError with code 'ERR_INVALID_THIS'

`ERR_INVALID_TRANSFER_OBJECT`

An invalid transfer object was passed to postMessage().

`ERR_INVALID_TUPLE`

An element in the iterable provided to the WHATWG
URLSearchParams constructor did not
represent a [name, value] tuple – that is, if an element is not iterable, or
does not consist of exactly two elements.

`ERR_INVALID_URI`

An invalid URI was passed.

`ERR_INVALID_URL`

An invalid URL was passed to the WHATWG URL
constructor or the legacy url.parse() to be parsed.
The thrown error object typically has an additional property 'input' that
contains the URL that failed to parse.

`ERR_INVALID_URL_SCHEME`

An attempt was made to use a URL of an incompatible scheme (protocol) for a
specific purpose. It is only used in the WHATWG URL API support in the
fs module (which only accepts URLs with 'file' scheme), but may be used
in other Node.js APIs as well in the future.

`ERR_IPC_CHANNEL_CLOSED`

An attempt was made to use an IPC communication channel that was already closed.

`ERR_IPC_DISCONNECTED`

An attempt was made to disconnect an IPC communication channel that was already
disconnected. See the documentation for the child_process module
for more information.

`ERR_IPC_ONE_PIPE`

An attempt was made to create a child Node.js process using more than one IPC
communication channel. See the documentation for the child_process module
for more information.

`ERR_IPC_SYNC_FORK`

An attempt was made to open an IPC communication channel with a synchronously
forked Node.js process. See the documentation for the child_process module
for more information.

`ERR_LOADER_CHAIN_INCOMPLETE`

An ESM loader hook returned without calling next() and without explicitly
signaling a short circuit.

`ERR_MANIFEST_ASSERT_INTEGRITY`

An attempt was made to load a resource, but the resource did not match the
integrity defined by the policy manifest. See the documentation for policy
manifests for more information.

`ERR_MANIFEST_DEPENDENCY_MISSING`

An attempt was made to load a resource, but the resource was not listed as a
dependency from the location that attempted to load it. See the documentation
for policy manifests for more information.

`ERR_MANIFEST_INTEGRITY_MISMATCH`

An attempt was made to load a policy manifest, but the manifest had multiple
entries for a resource which did not match each other. Update the manifest
entries to match in order to resolve this error. See the documentation for
policy manifests for more information.

`ERR_MANIFEST_INVALID_RESOURCE_FIELD`

A policy manifest resource had an invalid value for one of its fields. Update
the manifest entry to match in order to resolve this error. See the
documentation for policy manifests for more information.

`ERR_MANIFEST_INVALID_SPECIFIER`

A policy manifest resource had an invalid value for one of its dependency
mappings. Update the manifest entry to match to resolve this error. See the
documentation for policy manifests for more information.

`ERR_MANIFEST_PARSE_POLICY`

An attempt was made to load a policy manifest, but the manifest was unable to
be parsed. See the documentation for policy manifests for more information.

`ERR_MANIFEST_TDZ`

An attempt was made to read from a policy manifest, but the manifest
initialization has not yet taken place. This is likely a bug in Node.js.

`ERR_MANIFEST_UNKNOWN_ONERROR`

A policy manifest was loaded, but had an unknown value for its «onerror»
behavior. See the documentation for policy manifests for more information.

`ERR_MEMORY_ALLOCATION_FAILED`

An attempt was made to allocate memory (usually in the C++ layer) but it
failed.

`ERR_MESSAGE_TARGET_CONTEXT_UNAVAILABLE`

A message posted to a MessagePort could not be deserialized in the target
vm Context. Not all Node.js objects can be successfully instantiated in
any context at this time, and attempting to transfer them using postMessage()
can fail on the receiving side in that case.

`ERR_METHOD_NOT_IMPLEMENTED`

A method is required but not implemented.

`ERR_MISSING_ARGS`

A required argument of a Node.js API was not passed. This is only used for
strict compliance with the API specification (which in some cases may accept
func(undefined) but not func()). In most native Node.js APIs,
func(undefined) and func() are treated identically, and the
ERR_INVALID_ARG_TYPE error code may be used instead.

`ERR_MISSING_OPTION`

For APIs that accept options objects, some options might be mandatory. This code
is thrown if a required option is missing.

`ERR_MISSING_PASSPHRASE`

An attempt was made to read an encrypted key without specifying a passphrase.

`ERR_MISSING_PLATFORM_FOR_WORKER`

The V8 platform used by this instance of Node.js does not support creating
Workers. This is caused by lack of embedder support for Workers. In particular,
this error will not occur with standard builds of Node.js.

`ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST`

An object that needs to be explicitly listed in the transferList argument
is in the object passed to a postMessage() call, but is not provided
in the transferList for that call. Usually, this is a MessagePort.

In Node.js versions prior to v15.0.0, the error code being used here was
ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST. However, the set of
transferable object types has been expanded to cover more types than
MessagePort.

`ERR_MODULE_NOT_FOUND`

A module file could not be resolved by the ECMAScript modules loader while
attempting an import operation or when loading the program entry point.

`ERR_MULTIPLE_CALLBACK`

A callback was called more than once.

A callback is almost always meant to only be called once as the query
can either be fulfilled or rejected but not both at the same time. The latter
would be possible by calling a callback more than once.

`ERR_NAPI_CONS_FUNCTION`

While using Node-API, a constructor passed was not a function.

`ERR_NAPI_INVALID_DATAVIEW_ARGS`

While calling napi_create_dataview(), a given offset was outside the bounds
of the dataview or offset + length was larger than a length of given buffer.

`ERR_NAPI_INVALID_TYPEDARRAY_ALIGNMENT`

While calling napi_create_typedarray(), the provided offset was not a
multiple of the element size.

`ERR_NAPI_INVALID_TYPEDARRAY_LENGTH`

While calling napi_create_typedarray(), (length * size_of_element) + byte_offset was larger than the length of given buffer.

`ERR_NAPI_TSFN_CALL_JS`

An error occurred while invoking the JavaScript portion of the thread-safe
function.

`ERR_NAPI_TSFN_GET_UNDEFINED`

An error occurred while attempting to retrieve the JavaScript undefined
value.

`ERR_NAPI_TSFN_START_IDLE_LOOP`

On the main thread, values are removed from the queue associated with the
thread-safe function in an idle loop. This error indicates that an error
has occurred when attempting to start the loop.

`ERR_NAPI_TSFN_STOP_IDLE_LOOP`

Once no more items are left in the queue, the idle loop must be suspended. This
error indicates that the idle loop has failed to stop.

`ERR_NOT_BUILDING_SNAPSHOT`

An attempt was made to use operations that can only be used when building
V8 startup snapshot even though Node.js isn’t building one.

`ERR_NO_CRYPTO`

An attempt was made to use crypto features while Node.js was not compiled with
OpenSSL crypto support.

`ERR_NO_ICU`

An attempt was made to use features that require ICU, but Node.js was not
compiled with ICU support.

`ERR_NON_CONTEXT_AWARE_DISABLED`

A non-context-aware native addon was loaded in a process that disallows them.

`ERR_OUT_OF_RANGE`

A given value is out of the accepted range.

`ERR_PACKAGE_IMPORT_NOT_DEFINED`

The package.json "imports" field does not define the given internal
package specifier mapping.

`ERR_PACKAGE_PATH_NOT_EXPORTED`

The package.json "exports" field does not export the requested subpath.
Because exports are encapsulated, private internal modules that are not exported
cannot be imported through the package resolution, unless using an absolute URL.

`ERR_PARSE_ARGS_INVALID_OPTION_VALUE`

When strict set to true, thrown by util.parseArgs() if a {boolean}
value is provided for an option of type {string}, or if a {string}
value is provided for an option of type {boolean}.

`ERR_PARSE_ARGS_UNEXPECTED_POSITIONAL`

Thrown by util.parseArgs(), when a positional argument is provided and
allowPositionals is set to false.

`ERR_PARSE_ARGS_UNKNOWN_OPTION`

When strict set to true, thrown by util.parseArgs() if an argument
is not configured in options.

`ERR_PERFORMANCE_INVALID_TIMESTAMP`

An invalid timestamp value was provided for a performance mark or measure.

`ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS`

Invalid options were provided for a performance measure.

`ERR_PROTO_ACCESS`

Accessing Object.prototype.__proto__ has been forbidden using
--disable-proto=throw. Object.getPrototypeOf and
Object.setPrototypeOf should be used to get and set the prototype of an
object.

`ERR_REQUIRE_ESM`

Stability: 1 — Experimental

An attempt was made to require() an ES Module.

`ERR_SCRIPT_EXECUTION_INTERRUPTED`

Script execution was interrupted by SIGINT (For
example, Ctrl+C was pressed.)

`ERR_SCRIPT_EXECUTION_TIMEOUT`

Script execution timed out, possibly due to bugs in the script being executed.

`ERR_SERVER_ALREADY_LISTEN`

The server.listen() method was called while a net.Server was already
listening. This applies to all instances of net.Server, including HTTP, HTTPS,
and HTTP/2 Server instances.

`ERR_SERVER_NOT_RUNNING`

The server.close() method was called when a net.Server was not
running. This applies to all instances of net.Server, including HTTP, HTTPS,
and HTTP/2 Server instances.

`ERR_SOCKET_ALREADY_BOUND`

An attempt was made to bind a socket that has already been bound.

`ERR_SOCKET_BAD_BUFFER_SIZE`

An invalid (negative) size was passed for either the recvBufferSize or
sendBufferSize options in dgram.createSocket().

`ERR_SOCKET_BAD_PORT`

An API function expecting a port >= 0 and < 65536 received an invalid value.

`ERR_SOCKET_BAD_TYPE`

An API function expecting a socket type (udp4 or udp6) received an invalid
value.

`ERR_SOCKET_BUFFER_SIZE`

While using dgram.createSocket(), the size of the receive or send Buffer
could not be determined.

`ERR_SOCKET_CLOSED`

An attempt was made to operate on an already closed socket.

`ERR_SOCKET_CLOSED_BEFORE_CONNECTION`

When calling net.Socket.write() on a connecting socket and the socket was
closed before the connection was established.

`ERR_SOCKET_DGRAM_IS_CONNECTED`

A dgram.connect() call was made on an already connected socket.

`ERR_SOCKET_DGRAM_NOT_CONNECTED`

A dgram.disconnect() or dgram.remoteAddress() call was made on a
disconnected socket.

`ERR_SOCKET_DGRAM_NOT_RUNNING`

A call was made and the UDP subsystem was not running.

`ERR_SRI_PARSE`

A string was provided for a Subresource Integrity check, but was unable to be
parsed. Check the format of integrity attributes by looking at the
Subresource Integrity specification.

`ERR_STREAM_ALREADY_FINISHED`

A stream method was called that cannot complete because the stream was
finished.

`ERR_STREAM_CANNOT_PIPE`

An attempt was made to call stream.pipe() on a Writable stream.

`ERR_STREAM_DESTROYED`

A stream method was called that cannot complete because the stream was
destroyed using stream.destroy().

`ERR_STREAM_NULL_VALUES`

An attempt was made to call stream.write() with a null chunk.

`ERR_STREAM_PREMATURE_CLOSE`

An error returned by stream.finished() and stream.pipeline(), when a stream
or a pipeline ends non gracefully with no explicit error.

`ERR_STREAM_PUSH_AFTER_EOF`

An attempt was made to call stream.push() after a null(EOF) had been
pushed to the stream.

`ERR_STREAM_UNSHIFT_AFTER_END_EVENT`

An attempt was made to call stream.unshift() after the 'end' event was
emitted.

`ERR_STREAM_WRAP`

Prevents an abort if a string decoder was set on the Socket or if the decoder
is in objectMode.

const Socket = require('node:net').Socket;
const instance = new Socket();

instance.setEncoding('utf8');

`ERR_STREAM_WRITE_AFTER_END`

An attempt was made to call stream.write() after stream.end() has been
called.

`ERR_STRING_TOO_LONG`

An attempt has been made to create a string longer than the maximum allowed
length.

`ERR_SYNTHETIC`

An artificial error object used to capture the call stack for diagnostic
reports.

`ERR_SYSTEM_ERROR`

An unspecified or non-specific system error has occurred within the Node.js
process. The error object will have an err.info object property with
additional details.

`ERR_TAP_LEXER_ERROR`

An error representing a failing lexer state.

`ERR_TAP_PARSER_ERROR`

An error representing a failing parser state. Additional information about
the token causing the error is available via the cause property.

`ERR_TAP_VALIDATION_ERROR`

This error represents a failed TAP validation.

`ERR_TEST_FAILURE`

This error represents a failed test. Additional information about the failure
is available via the cause property. The failureType property specifies
what the test was doing when the failure occurred.

`ERR_TLS_CERT_ALTNAME_FORMAT`

This error is thrown by checkServerIdentity if a user-supplied
subjectaltname property violates encoding rules. Certificate objects produced
by Node.js itself always comply with encoding rules and will never cause
this error.

`ERR_TLS_CERT_ALTNAME_INVALID`

While using TLS, the host name/IP of the peer did not match any of the
subjectAltNames in its certificate.

`ERR_TLS_DH_PARAM_SIZE`

While using TLS, the parameter offered for the Diffie-Hellman (DH)
key-agreement protocol is too small. By default, the key length must be greater
than or equal to 1024 bits to avoid vulnerabilities, even though it is strongly
recommended to use 2048 bits or larger for stronger security.

`ERR_TLS_HANDSHAKE_TIMEOUT`

A TLS/SSL handshake timed out. In this case, the server must also abort the
connection.

`ERR_TLS_INVALID_CONTEXT`

The context must be a SecureContext.

`ERR_TLS_INVALID_PROTOCOL_METHOD`

The specified secureProtocol method is invalid. It is either unknown, or
disabled because it is insecure.

`ERR_TLS_INVALID_PROTOCOL_VERSION`

Valid TLS protocol versions are 'TLSv1', 'TLSv1.1', or 'TLSv1.2'.

`ERR_TLS_INVALID_STATE`

The TLS socket must be connected and securely established. Ensure the ‘secure’
event is emitted before continuing.

`ERR_TLS_PROTOCOL_VERSION_CONFLICT`

Attempting to set a TLS protocol minVersion or maxVersion conflicts with an
attempt to set the secureProtocol explicitly. Use one mechanism or the other.

`ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED`

Failed to set PSK identity hint. Hint may be too long.

`ERR_TLS_RENEGOTIATION_DISABLED`

An attempt was made to renegotiate TLS on a socket instance with renegotiation
disabled.

`ERR_TLS_REQUIRED_SERVER_NAME`

While using TLS, the server.addContext() method was called without providing
a host name in the first parameter.

`ERR_TLS_SESSION_ATTACK`

An excessive amount of TLS renegotiations is detected, which is a potential
vector for denial-of-service attacks.

`ERR_TLS_SNI_FROM_SERVER`

An attempt was made to issue Server Name Indication from a TLS server-side
socket, which is only valid from a client.

`ERR_TRACE_EVENTS_CATEGORY_REQUIRED`

The trace_events.createTracing() method requires at least one trace event
category.

`ERR_TRACE_EVENTS_UNAVAILABLE`

The node:trace_events module could not be loaded because Node.js was compiled
with the --without-v8-platform flag.

`ERR_TRANSFORM_ALREADY_TRANSFORMING`

A Transform stream finished while it was still transforming.

`ERR_TRANSFORM_WITH_LENGTH_0`

A Transform stream finished with data still in the write buffer.

`ERR_TTY_INIT_FAILED`

The initialization of a TTY failed due to a system error.

`ERR_UNAVAILABLE_DURING_EXIT`

Function was called within a process.on('exit') handler that shouldn’t be
called within process.on('exit') handler.

`ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET`

process.setUncaughtExceptionCaptureCallback() was called twice,
without first resetting the callback to null.

This error is designed to prevent accidentally overwriting a callback registered
from another module.

`ERR_UNESCAPED_CHARACTERS`

A string that contained unescaped characters was received.

`ERR_UNHANDLED_ERROR`

An unhandled error occurred (for instance, when an 'error' event is emitted
by an EventEmitter but an 'error' handler is not registered).

`ERR_UNKNOWN_BUILTIN_MODULE`

Used to identify a specific kind of internal Node.js error that should not
typically be triggered by user code. Instances of this error point to an
internal bug within the Node.js binary itself.

`ERR_UNKNOWN_CREDENTIAL`

A Unix group or user identifier that does not exist was passed.

`ERR_UNKNOWN_ENCODING`

An invalid or unknown encoding option was passed to an API.

`ERR_UNKNOWN_FILE_EXTENSION`

Stability: 1 — Experimental

An attempt was made to load a module with an unknown or unsupported file
extension.

`ERR_UNKNOWN_MODULE_FORMAT`

Stability: 1 — Experimental

An attempt was made to load a module with an unknown or unsupported format.

`ERR_UNKNOWN_SIGNAL`

An invalid or unknown process signal was passed to an API expecting a valid
signal (such as subprocess.kill()).

`ERR_UNSUPPORTED_DIR_IMPORT`

import a directory URL is unsupported. Instead,
self-reference a package using its name and define a custom subpath in
the "exports" field of the package.json file.

import './'; // unsupported
import './index.js'; // supported
import 'package-name'; // supported

`ERR_UNSUPPORTED_ESM_URL_SCHEME`

import with URL schemes other than file and data is unsupported.

`ERR_USE_AFTER_CLOSE`

Stability: 1 — Experimental

An attempt was made to use something that was already closed.

`ERR_VALID_PERFORMANCE_ENTRY_TYPE`

While using the Performance Timing API (perf_hooks), no valid performance
entry types are found.

`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`

A dynamic import callback was not specified.

`ERR_VM_MODULE_ALREADY_LINKED`

The module attempted to be linked is not eligible for linking, because of one of
the following reasons:

It has already been linked (linkingStatus is 'linked')
It is being linked (linkingStatus is 'linking')
Linking has failed for this module (linkingStatus is 'errored')

`ERR_VM_MODULE_CACHED_DATA_REJECTED`

The cachedData option passed to a module constructor is invalid.

`ERR_VM_MODULE_CANNOT_CREATE_CACHED_DATA`

Cached data cannot be created for modules which have already been evaluated.

`ERR_VM_MODULE_DIFFERENT_CONTEXT`

The module being returned from the linker function is from a different context
than the parent module. Linked modules must share the same context.

`ERR_VM_MODULE_LINK_FAILURE`

The module was unable to be linked due to a failure.

`ERR_VM_MODULE_NOT_MODULE`

The fulfilled value of a linking promise is not a vm.Module object.

`ERR_VM_MODULE_STATUS`

The current module’s status does not allow for this operation. The specific
meaning of the error depends on the specific function.

`ERR_WASI_ALREADY_STARTED`

The WASI instance has already started.

`ERR_WASI_NOT_STARTED`

The WASI instance has not been started.

`ERR_WEBASSEMBLY_RESPONSE`

The Response that has been passed to WebAssembly.compileStreaming or to
WebAssembly.instantiateStreaming is not a valid WebAssembly response.

`ERR_WORKER_INIT_FAILED`

The Worker initialization failed.

`ERR_WORKER_INVALID_EXEC_ARGV`

The execArgv option passed to the Worker constructor contains
invalid flags.

`ERR_WORKER_NOT_RUNNING`

An operation failed because the Worker instance is not currently running.

`ERR_WORKER_OUT_OF_MEMORY`

The Worker instance terminated because it reached its memory limit.

`ERR_WORKER_PATH`

The path for the main script of a worker is neither an absolute path
nor a relative path starting with ./ or ../.

`ERR_WORKER_UNSERIALIZABLE_ERROR`

All attempts at serializing an uncaught exception from a worker thread failed.

`ERR_WORKER_UNSUPPORTED_OPERATION`

The requested functionality is not supported in worker threads.

`ERR_ZLIB_INITIALIZATION_FAILED`

Creation of a zlib object failed due to incorrect configuration.

`HPE_HEADER_OVERFLOW`

Too much HTTP header data was received. In order to protect against malicious or
malconfigured clients, if more than 8 KiB of HTTP header data is received then
HTTP parsing will abort without a request or response object being created, and
an Error with this code will be emitted.

`HPE_UNEXPECTED_CONTENT_LENGTH`

Server is sending both a Content-Length header and Transfer-Encoding: chunked.

Transfer-Encoding: chunked allows the server to maintain an HTTP persistent
connection for dynamically generated content.
In this case, the Content-Length HTTP header cannot be used.

Use Content-Length or Transfer-Encoding: chunked.

`MODULE_NOT_FOUND`

A module file could not be resolved by the CommonJS modules loader while
attempting a require() operation or when loading the program entry point.

Legacy Node.js error codes

Stability: 0 — Deprecated. These error codes are either inconsistent, or have
been removed.

`ERR_CANNOT_TRANSFER_OBJECT`

The value passed to postMessage() contained an object that is not supported
for transferring.

`ERR_CRYPTO_HASH_DIGEST_NO_UTF16`

The UTF-16 encoding was used with hash.digest(). While the
hash.digest() method does allow an encoding argument to be passed in,
causing the method to return a string rather than a Buffer, the UTF-16
encoding (e.g. ucs or utf16le) is not supported.

`ERR_HTTP2_FRAME_ERROR`

Used when a failure occurs sending an individual frame on the HTTP/2
session.

`ERR_HTTP2_HEADERS_OBJECT`

Used when an HTTP/2 Headers Object is expected.

`ERR_HTTP2_HEADER_REQUIRED`

Used when a required header is missing in an HTTP/2 message.

`ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND`

HTTP/2 informational headers must only be sent prior to calling the
Http2Stream.prototype.respond() method.

`ERR_HTTP2_STREAM_CLOSED`

Used when an action has been performed on an HTTP/2 Stream that has already
been closed.

`ERR_HTTP_INVALID_CHAR`

Used when an invalid character is found in an HTTP response status message
(reason phrase).

`ERR_INDEX_OUT_OF_RANGE`

A given index was out of the accepted range (e.g. negative offsets).

`ERR_INVALID_OPT_VALUE`

An invalid or unexpected value was passed in an options object.

`ERR_INVALID_OPT_VALUE_ENCODING`

An invalid or unknown file encoding was passed.

`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`

This error code was replaced by ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST
in Node.js v15.0.0, because it is no longer accurate as other types of
transferable objects also exist now.

`ERR_NAPI_CONS_PROTOTYPE_OBJECT`

Used by the Node-API when Constructor.prototype is not an object.

`ERR_NETWORK_IMPORT_BAD_RESPONSE`

Stability: 1 — Experimental

Response was received but was invalid when importing a module over the network.

`ERR_NETWORK_IMPORT_DISALLOWED`

Stability: 1 — Experimental

A network module attempted to load another module that it is not allowed to
load. Likely this restriction is for security reasons.

`ERR_NO_LONGER_SUPPORTED`

A Node.js API was called in an unsupported manner, such as
Buffer.write(string, encoding, offset[, length]).

`ERR_OPERATION_FAILED`

An operation failed. This is typically used to signal the general failure
of an asynchronous operation.

`ERR_OUTOFMEMORY`

Used generically to identify that an operation caused an out of memory
condition.

`ERR_PARSE_HISTORY_DATA`

The node:repl module was unable to parse data from the REPL history file.

`ERR_SOCKET_CANNOT_SEND`

Data could not be sent on a socket.

`ERR_STDERR_CLOSE`

An attempt was made to close the process.stderr stream. By design, Node.js
does not allow stdout or stderr streams to be closed by user code.

`ERR_STDOUT_CLOSE`

An attempt was made to close the process.stdout stream. By design, Node.js
does not allow stdout or stderr streams to be closed by user code.

`ERR_STREAM_READ_NOT_IMPLEMENTED`

Used when an attempt is made to use a readable stream that has not implemented
readable._read().

`ERR_TLS_RENEGOTIATION_FAILED`

Used when a TLS renegotiation request has failed in a non-specific way.

`ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER`

A SharedArrayBuffer whose memory is not managed by the JavaScript engine
or by Node.js was encountered during serialization. Such a SharedArrayBuffer
cannot be serialized.

This can only happen when native addons create SharedArrayBuffers in
«externalized» mode, or put existing SharedArrayBuffer into externalized mode.

`ERR_UNKNOWN_STDIN_TYPE`

An attempt was made to launch a Node.js process with an unknown stdin file
type. This error is usually an indication of a bug within Node.js itself,
although it is possible for user code to trigger it.

`ERR_UNKNOWN_STREAM_TYPE`

An attempt was made to launch a Node.js process with an unknown stdout or
stderr file type. This error is usually an indication of a bug within Node.js
itself, although it is possible for user code to trigger it.

`ERR_V8BREAKITERATOR`

The V8 BreakIterator API was used but the full ICU data set is not installed.

`ERR_VALUE_OUT_OF_RANGE`

Used when a given value is out of the accepted range.

`ERR_VM_MODULE_NOT_LINKED`

The module must be successfully linked before instantiation.

`ERR_VM_MODULE_LINKING_ERRORED`

The linker function returned a module for which linking has failed.

`ERR_WORKER_UNSUPPORTED_EXTENSION`

The pathname used for the main script of a worker has an
unknown file extension.

`ERR_ZLIB_BINDING_CLOSED`

Used when an attempt is made to use a zlib object after it has already been
closed.

`ERR_CPU_USAGE`

The native call from process.cpuUsage could not be processed.

Источник

Ошибки¶

Приложения, работающие в Node.js, обычно сталкиваются с четырьмя категориями ошибок:

Стандартные ошибки JavaScript, такие как {EvalError}, {SyntaxError}, {RangeError}, {ReferenceError}, {TypeError} и {URIError}.
Системные ошибки, вызванные ограничениями базовой операционной системы, такими как попытка открыть несуществующий файл или попытка отправить данные через закрытый сокет.
Пользовательские ошибки, вызванные кодом приложения.
AssertionErrors — это особый класс ошибок, который может быть вызван, когда Node.js обнаруживает исключительное логическое нарушение, которое никогда не должно происходить. Обычно они поднимаются assert модуль.

Все ошибки JavaScript и системные ошибки, вызванные Node.js, наследуются от стандартного класса {Error} JavaScript или являются его экземплярами и гарантированно предоставляют по меньшей мере свойства, доступные в этом классе.

Распространение ошибок и перехват¶

Node.js поддерживает несколько механизмов распространения и обработки ошибок, возникающих во время работы приложения. То, как эти ошибки сообщаются и обрабатываются, полностью зависит от типа Error и стиль вызываемого API.

Все ошибки JavaScript обрабатываются как исключения, которые немедленно генерировать и выдавать ошибку с помощью стандартного JavaScript throw механизм. Они обрабатываются с помощью try…catch строить предоставляется языком JavaScript.

// Throws with a ReferenceError because z is not defined.
try {
  const m = 1;
  const n = m + z;
} catch (err) {
  // Handle the error here.
}

Любое использование JavaScript throw механизм вызовет исключение, которое должен обрабатываться с использованием try…catch или процесс Node.js немедленно завершится.

За некоторыми исключениями, Синхронный API (любой метод блокировки, не принимающий callback функция, например fs.readFileSync), буду использовать throw сообщать об ошибках.

Ошибки, возникающие внутри Асинхронные API можно сообщить несколькими способами:

Большинство асинхронных методов, которые принимают callback функция примет Error объект, переданный в качестве первого аргумента этой функции. Если этот первый аргумент не null и является экземпляром Error, то произошла ошибка, которую необходимо обработать.

const fs = require('fs');
fs.readFile('a file that does not exist', (err, data) => {
  if (err) {
    console.error(
      'There was an error reading the file!',
      err
    );
    return;
  }
  // Otherwise handle the data
});

Когда асинхронный метод вызывается для объекта, который является EventEmitter, ошибки могут быть перенаправлены на этот объект 'error' событие.

const net = require('net');
const connection = net.connect('localhost');

// Adding an 'error' event handler to a stream:
connection.on('error', (err) => {
  // If the connection is reset by the server, or if it can't
  // connect at all, or on any sort of error encountered by
  // the connection, the error will be sent here.
  console.error(err);
});

connection.pipe(process.stdout);

Некоторые обычно асинхронные методы в API Node.js могут по-прежнему использовать throw механизм для создания исключений, которые должны обрабатываться с помощью try…catch. Исчерпывающего списка таких методов нет; обратитесь к документации по каждому методу, чтобы определить соответствующий требуемый механизм обработки ошибок.

Использование 'error' механизм событий наиболее распространен для потоковый а также на основе эмиттера событий API-интерфейсы, которые сами по себе представляют собой серию асинхронных операций с течением времени (в отличие от одной операции, которая может пройти или закончиться неудачей).

Для все EventEmitter объекты, если 'error' обработчик событий не предоставляется, будет выдана ошибка, в результате чего процесс Node.js сообщит о неперехваченном исключении и завершится сбоем, если только одно из следующих событий: domain модуль используется надлежащим образом или обработчик зарегистрирован для 'uncaughtException' событие.

const EventEmitter = require('events');
const ee = new EventEmitter();

setImmediate(() => {
  // This will crash the process because no 'error' event
  // handler has been added.
  ee.emit('error', new Error('This will crash'));
});

Ошибки, сгенерированные таким образом не мочь быть перехваченным с помощью try…catch как они брошены после код вызова уже вышел.

Разработчики должны обращаться к документации по каждому методу, чтобы точно определить, как распространяются ошибки, вызванные этими методами.

Обратные вызовы при первой ошибке¶

Большинство асинхронных методов, предоставляемых основным API Node.js, следуют идиоматическому шаблону, называемому обратный вызов при первой ошибке. В этом шаблоне функция обратного вызова передается методу в качестве аргумента. Когда операция завершается или возникает ошибка, вызывается функция обратного вызова с Error объект (если есть) передается в качестве первого аргумента. Если ошибки не возникло, первый аргумент будет передан как null.

const fs = require('fs');

function errorFirstCallback(err, data) {
  if (err) {
    console.error('There was an error', err);
    return;
  }
  console.log(data);
}

fs.readFile(
  '/some/file/that/does-not-exist',
  errorFirstCallback
);
fs.readFile(
  '/some/file/that/does-exist',
  errorFirstCallback
);

JavaScript try…catch механизм не мочь использоваться для перехвата ошибок, генерируемых асинхронными API. Распространенная ошибка новичков — пытаться использовать throw внутри обратного вызова с ошибкой:

// THIS WILL NOT WORK:
const fs = require('fs');

try {
  fs.readFile(
    '/some/file/that/does-not-exist',
    (err, data) => {
      // Mistaken assumption: throwing here...
      if (err) {
        throw err;
      }
    }
  );
} catch (err) {
  // This will not catch the throw!
  console.error(err);
}

Это не сработает, потому что функция обратного вызова передана в fs.readFile() вызывается асинхронно. К моменту вызова обратного вызова окружающий код, включая try…catch блок, уже вышли. Выдача ошибки внутри обратного вызова может привести к сбою процесса Node.js в большинстве случаев. Если домены включены, или обработчик был зарегистрирован с process.on('uncaughtException'), такие ошибки можно перехватить.

Класс: `Error`¶

Общий объект JavaScript {Error}, не указывающий на конкретную причину возникновения ошибки. Error объекты фиксируют «трассировку стека», детализирующую точку в коде, в которой Error был создан, и может содержать текстовое описание ошибки.

Все ошибки, генерируемые Node.js, включая все системные ошибки и ошибки JavaScript, будут либо экземплярами, либо унаследованы от Error класс.

`new Error(message)`¶

message {нить}

Создает новый Error объект и устанавливает error.message в предоставленное текстовое сообщение. Если объект передается как message, текстовое сообщение создается при вызове message.toString(). В error.stack свойство будет представлять точку в коде, в которой new Error() назывался. Трассировки стека зависят от API трассировки стека V8. Трассировки стека распространяются только на (а) начало синхронное выполнение кода, или (b) количество кадров, заданное свойством Error.stackTraceLimit, в зависимости от того, что меньше.

`Error.captureStackTrace(targetObject[, constructorOpt])`¶

targetObject {Объект}
constructorOpt {Функция}

Создает .stack собственность на targetObject, который при доступе возвращает строку, представляющую место в коде, в котором Error.captureStackTrace() назывался.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`

Первая строка трассировки будет иметь префикс ${myObject.name}: ${myObject.message}.

Необязательный constructorOpt Аргумент принимает функцию. Если указано, все кадры выше constructorOpt, включая constructorOpt, будет исключен из сгенерированной трассировки стека.

В constructorOpt Аргумент полезен для сокрытия деталей реализации генерации ошибок от пользователя. Например:

function MyError() {
  Error.captureStackTrace(this, MyError);
}

// Without passing MyError to captureStackTrace, the MyError
// frame would show up in the .stack property. By passing
// the constructor, we omit that frame, and retain all frames below it.
new MyError().stack;

`Error.stackTraceLimit`¶

{количество}

В Error.stackTraceLimit указывает количество кадров стека, собранных трассировкой стека (независимо от того, сгенерированы ли они new Error().stack или Error.captureStackTrace(obj)).

Значение по умолчанию — 10 но может быть установлен на любой допустимый номер JavaScript. Изменения повлияют на любую записанную трассировку стека. после значение было изменено.

Если установлено нечисловое значение или задано отрицательное число, трассировки стека не будут захватывать какие-либо кадры.

`error.code`¶

{нить}

В error.code Свойство — это строковая метка, определяющая тип ошибки. error.code это наиболее стабильный способ выявления ошибки. Он будет меняться только между основными версиями Node.js. Наоборот, error.message строки могут меняться между любыми версиями Node.js. Видеть Коды ошибок Node.js для получения подробной информации о конкретных кодах.

`error.message`¶

{нить}

В error.message свойство — это строковое описание ошибки, установленное при вызове new Error(message). В message переданный конструктору, также появится в первой строке трассировки стека Error, однако изменение этого свойства после Error объект создан может нет изменить первую строку трассировки стека (например, когда error.stack читается до изменения этого свойства).

const err = new Error('The message');
console.error(err.message);
// Prints: The message

`error.stack`¶

{нить}

В error.stack свойство — это строка, описывающая точку в коде, в которой Error был создан.

Error: Things keep happening!
   at /home/gbusey/file.js:525:2
   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)
   at increaseSynergy (/home/gbusey/actors.js:701:6)

Первая строка отформатирована как <error class name>: <error message>, за которым следует серия кадров стека (каждая строка начинается с «at»). Каждый фрейм описывает сайт вызова в коде, который приводит к сгенерированной ошибке. V8 пытается отобразить имя для каждой функции (по имени переменной, имени функции или имени метода объекта), но иногда не может найти подходящее имя. Если V8 не может определить имя функции, для этого фрейма будет отображаться только информация о местоположении. В противном случае определенное имя функции будет отображаться с информацией о местоположении, добавленной в круглые скобки.

Фреймы создаются только для функций JavaScript. Если, например, выполнение синхронно проходит через дополнительную функцию C ++, называемую cheetahify который сам вызывает функцию JavaScript, фрейм, представляющий cheetahify вызов не будет присутствовать в трассировке стека:

const cheetahify = require('./native-binding.node');

function makeFaster() {
  // `cheetahify()` *synchronously* calls speedy.
  cheetahify(function speedy() {
    throw new Error('oh no!');
  });
}

makeFaster();
// will throw:
//   /home/gbusey/file.js:6
//       throw new Error('oh no!');
//           ^
//   Error: oh no!
//       at speedy (/home/gbusey/file.js:6:11)
//       at makeFaster (/home/gbusey/file.js:5:3)
//       at Object.<anonymous> (/home/gbusey/file.js:10:1)
//       at Module._compile (module.js:456:26)
//       at Object.Module._extensions..js (module.js:474:10)
//       at Module.load (module.js:356:32)
//       at Function.Module._load (module.js:312:12)
//       at Function.Module.runMain (module.js:497:10)
//       at startup (node.js:119:16)
//       at node.js:906:3

Информация о местоположении будет одной из следующих:

native, если кадр представляет внутренний вызов V8 (как в [].forEach).
plain-filename.js:line:column, если фрейм представляет собой внутренний вызов Node.js.
/absolute/path/to/file.js:line:column, если кадр представляет собой вызов в пользовательской программе или ее зависимостях.

Строка, представляющая трассировку стека, генерируется лениво, когда error.stack собственность доступ.

Количество кадров, захваченных трассировкой стека, ограничено меньшим из Error.stackTraceLimit или количество доступных кадров в текущем тике цикла событий.

Класс: `AssertionError`¶

Расширяется: {errors.Error}

Указывает на неудачу утверждения. Подробнее см. Class: assert.AssertionError.

Класс: `RangeError`¶

Расширяется: {errors.Error}

Указывает, что предоставленный аргумент находится за пределами набора или диапазона допустимых значений для функции; является ли это числовым диапазоном или вне набора опций для данного параметра функции.

require('net').connect(-1);
// Throws "RangeError: "port" option should be >= 0 and < 65536: -1"

Node.js сгенерирует и выбросит RangeError экземпляры немедленно как форма подтверждения аргумента.

Класс: `ReferenceError`¶

Расширяется: {errors.Error}

Указывает, что предпринимается попытка получить доступ к переменной, которая не определена. Такие ошибки обычно указывают на опечатки в коде или на некорректную программу.

Хотя клиентский код может генерировать и распространять эти ошибки, на практике это будет делать только V8.

doesNotExist;
// Throws ReferenceError, doesNotExist is not a variable in this program.

Если приложение динамически не генерирует и не запускает код, ReferenceError экземпляры указывают на ошибку в коде или его зависимостях.

Класс: `SyntaxError`¶

Расширяется: {errors.Error}

Указывает, что программа не является допустимым JavaScript. Эти ошибки могут возникать и распространяться только в результате оценки кода. Оценка кода может произойти в результате eval, Function, require, или vm. Эти ошибки почти всегда указывают на неработающую программу.

try {
  require('vm').runInThisContext('binary ! isNotOk');
} catch (err) {
  // 'err' will be a SyntaxError.
}

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

Класс: `SystemError`¶

Расширяется: {errors.Error}

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

address {строка} Если присутствует, адрес, к которому не удалось подключиться к сети.
code {строка} Код ошибки строки
dest {строка} Если присутствует, путь к файлу при сообщении об ошибке файловой системы
errno {number} Номер ошибки, предоставленный системой
info {Object} Если присутствует, дополнительные сведения о состоянии ошибки
message {string} Предоставляемое системой описание ошибки в удобной для чтения форме.
path {строка} Если присутствует, путь к файлу при сообщении об ошибке файловой системы
port {number} Если присутствует, порт сетевого подключения, который недоступен
syscall {строка} Имя системного вызова, вызвавшего ошибку

`error.address`¶

{нить}

Если представить, error.address — это строка, описывающая адрес, к которому не удалось установить сетевое соединение.

`error.code`¶

{нить}

В error.code свойство — это строка, представляющая код ошибки.

`error.dest`¶

{нить}

Если представить, error.dest — это путь к файлу при сообщении об ошибке файловой системы.

`error.errno`¶

{количество}

В error.errno свойство — отрицательное число, которое соответствует коду ошибки, определенному в libuv Error handling.

В Windows номер ошибки, предоставленный системой, будет нормализован libuv.

Чтобы получить строковое представление кода ошибки, используйте util.getSystemErrorName(error.errno).

`error.info`¶

{Объект}

Если представить, error.info — объект с подробной информацией о состоянии ошибки.

`error.message`¶

{нить}

error.message представляет собой удобочитаемое описание ошибки, предоставляемое системой.

`error.path`¶

{нить}

Если представить, error.path — строка, содержащая соответствующий недопустимый путь.

`error.port`¶

{количество}

Если представить, error.port порт сетевого подключения недоступен.

`error.syscall`¶

{нить}

В error.syscall свойство — это строка, описывающая системный вызов это не удалось.

Общие системные ошибки¶

Это список системных ошибок, которые часто встречаются при написании программы на Node.js. Полный список см. В errno(3) справочная страница.

EACCES (В разрешении отказано): была сделана попытка получить доступ к файлу способом, запрещенным его разрешениями на доступ к файлу.
EADDRINUSE (Адрес уже используется): попытка привязать сервер (net, http, или https) на локальный адрес не удалось из-за того, что другой сервер в локальной системе уже занимает этот адрес.
ECONNREFUSED (В соединении отказано): соединение не может быть установлено, потому что целевая машина активно отказалась от него. Обычно это происходит из-за попытки подключиться к неактивной службе на чужом хосте.
ECONNRESET (Сброс соединения одноранговым узлом): соединение было принудительно закрыто одноранговым узлом. Обычно это происходит из-за потери соединения с удаленным сокетом из-за тайм-аута или перезагрузки. Обычно встречается через http а также net модули.
EEXIST (Файл существует): существующий файл был целью операции, которая требовала, чтобы цель не существовала.
EISDIR (Является каталогом): операция ожидала файл, но указанный путь был каталогом.
EMFILE (Слишком много открытых файлов в системе): максимальное количество файловые дескрипторы допустимый в системе, и запросы для другого дескриптора не могут быть выполнены, пока хотя бы один из них не будет закрыт. Это происходит при одновременном открытии множества файлов одновременно, особенно в системах (в частности, macOS), где существует низкий предел дескрипторов файлов для процессов. Чтобы исправить низкий предел, запустите ulimit -n 2048 в той же оболочке, которая будет запускать процесс Node.js.
ENOENT (Нет такого файла или каталога): обычно создается fs операции, чтобы указать, что компонент указанного пути не существует. По указанному пути не удалось найти ни один объект (файл или каталог).
ENOTDIR (Не каталог): компонент с указанным путем существует, но не является каталогом, как ожидалось. Обычно выращивается fs.readdir.
ENOTEMPTY (Каталог не пустой): каталог с записями был целью операции, для которой требуется пустой каталог, обычно fs.unlink.
ENOTFOUND (Ошибка поиска DNS): указывает на сбой DNS либо EAI_NODATA или EAI_NONAME. Это не стандартная ошибка POSIX.
EPERM (Операция запрещена): была сделана попытка выполнить операцию, требующую повышенных привилегий.
EPIPE (Сломанный канал): запись в канал, сокет или FIFO, для которого нет процесса для чтения данных. Часто встречается на net а также http Уровни, указывающие на то, что удаленная сторона записываемого потока была закрыта.
ETIMEDOUT (Превышено время ожидания операции): запрос на подключение или отправку завершился неудачно, поскольку подключенная сторона не ответила должным образом по прошествии определенного периода времени. Обычно встречается http или net. Часто признак того, что socket.end() не был должным образом назван.

Класс: `TypeError`¶

Расширяет {errors.Error}

Указывает, что указанный аргумент не является допустимым типом. Например, передача функции параметру, который ожидает строку, будет TypeError.

require('url').parse(() => {});
// Throws TypeError, since it expected a string.

Node.js сгенерирует и выбросит TypeError экземпляры немедленно как форма подтверждения аргумента.

Исключения против ошибок¶

Исключение JavaScript — это значение, которое выбрасывается в результате недопустимой операции или как цель throw утверждение. Хотя не требуется, чтобы эти значения были экземплярами Error или классы, которые наследуются от Error, все исключения, создаваемые Node.js или средой выполнения JavaScript буду быть экземплярами Error.

Некоторые исключения безвозвратно на уровне JavaScript. Такие исключения будут всегда вызвать сбой процесса Node.js. Примеры включают assert() чеки или abort() вызывает в слое C ++.

Ошибки OpenSSL¶

Ошибки, возникающие в crypto или tls классные Error, и в дополнение к стандартному .code а также .message properties, могут иметь некоторые дополнительные свойства, специфичные для OpenSSL.

`error.opensslErrorStack`¶

Массив ошибок, который может дать контекст, откуда в библиотеке OpenSSL возникла ошибка.

`error.function`¶

Функция OpenSSL, в которой возникла ошибка.

`error.library`¶

Библиотека OpenSSL, в которой возникла ошибка.

`error.reason`¶

Строка в удобном для чтения виде, описывающая причину ошибки.

`ABORT_ERR`¶

Используется, когда операция была прервана (обычно с использованием AbortController).

API нет с использованием AbortSignals обычно не вызывают ошибки с этим кодом.

Этот код не использует обычный ERR_* соглашение об ошибках Node.js используется для обеспечения совместимости с веб-платформой. AbortError.

`ERR_AMBIGUOUS_ARGUMENT`¶

Аргумент функции используется таким образом, чтобы предположить, что сигнатура функции может быть неправильно понята. Это брошено assert модуль, когда message параметр в assert.throws(block, message) совпадает с сообщением об ошибке, выданным block потому что это использование предполагает, что пользователь верит message ожидаемое сообщение, а не сообщение AssertionError будет отображаться, если block не бросает.

`ERR_ARG_NOT_ITERABLE`¶

Итерируемый аргумент (т.е. значение, которое работает с for...of loops) требуется, но не предоставляется API Node.js.

`ERR_ASSERTION`¶

Особый тип ошибки, которая может быть вызвана всякий раз, когда Node.js обнаруживает исключительное логическое нарушение, которое никогда не должно происходить. Обычно они поднимаются assert модуль.

`ERR_ASYNC_CALLBACK`¶

Была сделана попытка зарегистрировать что-то, что не является функцией, как AsyncHooks Перезвоните.

`ERR_ASYNC_TYPE`¶

Недопустимый тип асинхронного ресурса. Пользователи также могут определять свои собственные типы при использовании общедоступного API для встраивания.

`ERR_BROTLI_COMPRESSION_FAILED`¶

Данные, переданные в поток Brotli, не были успешно сжаты.

`ERR_BROTLI_INVALID_PARAM`¶

Во время построения потока Brotli был передан недопустимый ключ параметра.

`ERR_BUFFER_CONTEXT_NOT_AVAILABLE`¶

Была сделана попытка создать Node.js Buffer из кода надстройки или встраивания, находясь в контексте механизма JS, который не связан с экземпляром Node.js. Данные, переданные в Buffer будет выпущен к тому времени, когда метод вернется.

При возникновении этой ошибки возможная альтернатива созданию Buffer пример — создать нормальный Uint8Array, который отличается только прототипом результирующего объекта. Uint8Arrays общеприняты во всех основных API Node.js, где Buffers есть; они доступны во всех контекстах.

`ERR_BUFFER_OUT_OF_BOUNDS`¶

Операция за пределами Buffer была предпринята попытка.

`ERR_BUFFER_TOO_LARGE`¶

Была сделана попытка создать Buffer больше максимально допустимого размера.

`ERR_CANNOT_WATCH_SIGINT`¶

Node.js не смог отследить SIGINT сигнал.

`ERR_CHILD_CLOSED_BEFORE_REPLY`¶

Дочерний процесс был закрыт до того, как родительский процесс получил ответ.

`ERR_CHILD_PROCESS_IPC_REQUIRED`¶

Используется, когда дочерний процесс разветвляется без указания канала IPC.

`ERR_CHILD_PROCESS_STDIO_MAXBUFFER`¶

Используется, когда основной процесс пытается прочитать данные из STDERR / STDOUT дочернего процесса, и длина данных больше, чем maxBuffer вариант.

`ERR_CLOSED_MESSAGE_PORT`¶

Была попытка использовать MessagePort экземпляр в закрытом состоянии, обычно после .close() был вызван.

`ERR_CONSOLE_WRITABLE_STREAM`¶

Console был создан без stdout поток, или Console имеет незаписываемый stdout или stderr транслировать.

`ERR_CONSTRUCT_CALL_INVALID`¶

Был вызван конструктор класса, который нельзя вызвать.

`ERR_CONSTRUCT_CALL_REQUIRED`¶

Конструктор класса был вызван без new.

`ERR_CONTEXT_NOT_INITIALIZED`¶

Контекст vm, переданный в API, еще не инициализирован. Это может произойти при возникновении (и обнаружении) ошибки во время создания контекста, например, при сбое выделения или при достижении максимального размера стека вызовов при создании контекста.

`ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED`¶

Был запрошен механизм сертификатов клиента, который не поддерживается используемой версией OpenSSL.

`ERR_CRYPTO_ECDH_INVALID_FORMAT`¶

Недопустимое значение для format аргумент был передан crypto.ECDH() класс getPublicKey() метод.

`ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY`¶

Недопустимое значение для key аргумент был передан crypto.ECDH() класс computeSecret() метод. Это означает, что открытый ключ лежит за пределами эллиптической кривой.

`ERR_CRYPTO_ENGINE_UNKNOWN`¶

Неверный идентификатор криптографической машины был передан в require('crypto').setEngine().

`ERR_CRYPTO_FIPS_FORCED`¶

В --force-fips был использован аргумент командной строки, но была попытка включить или отключить режим FIPS в crypto модуль.

`ERR_CRYPTO_FIPS_UNAVAILABLE`¶

Была сделана попытка включить или отключить режим FIPS, но режим FIPS был недоступен.

`ERR_CRYPTO_HASH_FINALIZED`¶

hash.digest() вызвали несколько раз. В hash.digest() метод должен вызываться не более одного раза для каждого экземпляра Hash объект.

`ERR_CRYPTO_HASH_UPDATE_FAILED`¶

hash.update() не удалось по какой-либо причине. Это должно происходить редко, если вообще когда-либо случаться.

`ERR_CRYPTO_INCOMPATIBLE_KEY`¶

Указанные криптографические ключи несовместимы с предпринятой операцией.

`ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS`¶

Выбранная кодировка открытого или закрытого ключа несовместима с другими параметрами.

`ERR_CRYPTO_INITIALIZATION_FAILED`¶

Не удалось инициализировать криптоподсистему.

`ERR_CRYPTO_INVALID_AUTH_TAG`¶

Предоставлен недопустимый тег аутентификации.

`ERR_CRYPTO_INVALID_COUNTER`¶

Для шифра режима противодействия предоставлен неверный счетчик.

`ERR_CRYPTO_INVALID_CURVE`¶

Была предоставлена неверная эллиптическая кривая.

`ERR_CRYPTO_INVALID_DIGEST`¶

Недействительный алгоритм криптодайджеста было указано.

`ERR_CRYPTO_INVALID_IV`¶

Предоставлен недопустимый вектор инициализации.

`ERR_CRYPTO_INVALID_JWK`¶

Был предоставлен недопустимый веб-ключ JSON.

`ERR_CRYPTO_INVALID_KEY_OBJECT_TYPE`¶

Данный тип объекта криптографического ключа недопустим для выполняемой операции.

`ERR_CRYPTO_INVALID_KEYLEN`¶

Была предоставлена неверная длина ключа.

`ERR_CRYPTO_INVALID_KEYPAIR`¶

Была предоставлена неверная пара ключей.

`ERR_CRYPTO_INVALID_KEYTYPE`¶

Предоставлен недопустимый тип ключа.

`ERR_CRYPTO_INVALID_MESSAGELEN`¶

Была предоставлена неверная длина сообщения.

`ERR_CRYPTO_INVALID_SCRYPT_PARAMS`¶

Были предоставлены неверные параметры алгоритма шифрования.

`ERR_CRYPTO_INVALID_STATE`¶

Крипто-метод был использован для объекта, находившегося в недопустимом состоянии. Например, позвонив cipher.getAuthTag() перед звонком cipher.final().

`ERR_CRYPTO_INVALID_TAG_LENGTH`¶

Предоставлена неверная длина тега аутентификации.

`ERR_CRYPTO_JOB_INIT_FAILED`¶

Не удалось инициализировать асинхронную криптооперацию.

`ERR_CRYPTO_JWK_UNSUPPORTED_CURVE`¶

Эллиптическая кривая Ключа не зарегистрирована для использования в Реестр эллиптических кривых веб-ключей JSON.

`ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE`¶

Тип асимметричного ключа ключа не зарегистрирован для использования в Реестр типов веб-ключей JSON.

`ERR_CRYPTO_OPERATION_FAILED`¶

Криптооперация завершилась неудачно по неустановленной причине.

`ERR_CRYPTO_PBKDF2_ERROR`¶

Алгоритм PBKDF2 завершился неудачно по неустановленным причинам. OpenSSL не предоставляет более подробной информации, и, следовательно, Node.js.

`ERR_CRYPTO_SCRYPT_INVALID_PARAMETER`¶

Один или больше crypto.scrypt() или crypto.scryptSync() параметры находятся за пределами допустимого диапазона.

`ERR_CRYPTO_SCRYPT_NOT_SUPPORTED`¶

Node.js был скомпилирован без scrypt служба поддержки. Невозможно с официальными двоичными файлами выпуска, но может произойти с пользовательскими сборками, включая сборки дистрибутива.

`ERR_CRYPTO_SIGN_KEY_REQUIRED`¶

Подпись key не был предоставлен sign.sign() метод.

`ERR_CRYPTO_TIMING_SAFE_EQUAL_LENGTH`¶

crypto.timingSafeEqual() был вызван с Buffer, TypedArray, или DataView аргументы разной длины.

`ERR_CRYPTO_UNKNOWN_CIPHER`¶

Указан неизвестный шифр.

`ERR_CRYPTO_UNKNOWN_DH_GROUP`¶

Было дано неизвестное название группы Диффи-Хеллмана. Видеть crypto.getDiffieHellman() для списка допустимых имен групп.

`ERR_CRYPTO_UNSUPPORTED_OPERATION`¶

Была сделана попытка вызвать неподдерживаемую криптографическую операцию.

`ERR_DEBUGGER_ERROR`¶

Произошла ошибка с отладчик.

`ERR_DEBUGGER_STARTUP_ERROR`¶

В отладчик истекло время ожидания освобождения необходимого хоста / порта.

`ERR_DLOPEN_DISABLED`¶

Загрузка собственных надстроек отключена с помощью --no-addons.

`ERR_DLOPEN_FAILED`¶

Звонок в process.dlopen() не смогли.

`ERR_DIR_CLOSED`¶

В fs.Dir ранее был закрыт.

`ERR_DIR_CONCURRENT_OPERATION`¶

Была предпринята попытка синхронного чтения или закрытия fs.Dir который имеет текущие асинхронные операции.

`ERR_DNS_SET_SERVERS_FAILED`¶

c-ares не удалось установить DNS-сервер.

`ERR_DOMAIN_CALLBACK_NOT_AVAILABLE`¶

В domain модуль нельзя было использовать, так как он не мог установить требуемые перехватчики обработки ошибок, потому что process.setUncaughtExceptionCaptureCallback() был вызван в более ранний момент времени.

`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`¶

process.setUncaughtExceptionCaptureCallback() нельзя было назвать, потому что domain модуль был загружен раньше.

Трассировка стека расширяется, чтобы включить момент времени, в который domain модуль был загружен.

`ERR_ENCODING_INVALID_ENCODED_DATA`¶

Данные предоставлены TextDecoder() API был недопустимым в соответствии с предоставленной кодировкой.

`ERR_ENCODING_NOT_SUPPORTED`¶

Кодировка предоставлена TextDecoder() API не был одним из WHATWG Поддерживаемые кодировки.

`ERR_EVAL_ESM_CANNOT_PRINT`¶

--print не может использоваться с входом ESM.

`ERR_EVENT_RECURSION`¶

Вызывается, когда делается попытка рекурсивно отправить событие на EventTarget.

`ERR_EXECUTION_ENVIRONMENT_NOT_AVAILABLE`¶

Контекст выполнения JS не связан со средой Node.js. Это может произойти, если Node.js используется в качестве встроенной библиотеки и некоторые хуки для движка JS не настроены должным образом.

`ERR_FALSY_VALUE_REJECTION`¶

А Promise это было выполнено обратным вызовом через util.callbackify() был отклонен с ложным значением.

`ERR_FEATURE_UNAVAILABLE_ON_PLATFORM`¶

Используется, когда используется функция, недоступная для текущей платформы, на которой работает Node.js.

`ERR_FS_CP_DIR_TO_NON_DIR`¶

Была сделана попытка скопировать каталог в не каталог (файл, символическую ссылку и т. Д.) С помощью fs.cp().

`ERR_FS_CP_EEXIST`¶

Была сделана попытка скопировать файл, который уже существовал с fs.cp(), с force а также errorOnExist установлен в true.

`ERR_FS_CP_EINVAL`¶

Когда используешь fs.cp(), src или dest указал на недопустимый путь.

`ERR_FS_CP_FIFO_PIPE`¶

Была сделана попытка скопировать именованный канал с fs.cp().

`ERR_FS_CP_NON_DIR_TO_DIR`¶

Была сделана попытка скопировать не каталог (файл, символическую ссылку и т. Д.) В каталог с помощью fs.cp().

`ERR_FS_CP_SOCKET`¶

Была сделана попытка скопировать в сокет с fs.cp().

`ERR_FS_CP_SYMLINK_TO_SUBDIRECTORY`¶

Когда используешь fs.cp(), символическая ссылка в dest указал на подкаталог src.

`ERR_FS_CP_UNKNOWN`¶

Была сделана попытка скопировать файл неизвестного типа с fs.cp().

`ERR_FS_EISDIR`¶

Путь — это каталог.

`ERR_FS_FILE_TOO_LARGE`¶

Была сделана попытка прочитать файл, размер которого превышает максимально допустимый размер для Buffer.

`ERR_FS_INVALID_SYMLINK_TYPE`¶

Недопустимый тип символической ссылки был передан в fs.symlink() или fs.symlinkSync() методы.

Была сделана попытка добавить дополнительные заголовки после того, как они уже были отправлены.

Указано недопустимое значение заголовка HTTP.

`ERR_HTTP_INVALID_STATUS_CODE`¶

Код состояния находился за пределами обычного диапазона кодов состояния (100–999).

`ERR_HTTP_REQUEST_TIMEOUT`¶

Клиент не отправил весь запрос в отведенное время.

`ERR_HTTP_SOCKET_ENCODING`¶

Изменение кодировки сокета запрещено RFC 7230, раздел 3.

`ERR_HTTP_TRAILER_INVALID`¶

В Trailer заголовок был установлен, хотя кодировка передачи не поддерживает это.

`ERR_HTTP2_ALTSVC_INVALID_ORIGIN`¶

Для фреймов HTTP / 2 ALTSVC требуется действительное происхождение.

`ERR_HTTP2_ALTSVC_LENGTH`¶

Кадры HTTP / 2 ALTSVC ограничены максимум 16 382 байтами полезной нагрузки.

Для запросов HTTP / 2 с использованием CONNECT метод, :authority псевдозаголовок обязателен.

`ERR_HTTP2_CONNECT_PATH`¶

Для запросов HTTP / 2 с использованием CONNECT метод, :path псевдозаголовок запрещен.

`ERR_HTTP2_CONNECT_SCHEME`¶

Для запросов HTTP / 2 с использованием CONNECT метод, :scheme псевдозаголовок запрещен.

`ERR_HTTP2_ERROR`¶

Произошла неспецифическая ошибка HTTP / 2.

`ERR_HTTP2_GOAWAY_SESSION`¶

Новые потоки HTTP / 2 нельзя открывать после Http2Session получил GOAWAY кадр от подключенного однорангового узла.

Было предоставлено несколько значений для поля заголовка HTTP / 2, которое должно было иметь только одно значение.

Дополнительные заголовки были указаны после того, как был инициирован ответ HTTP / 2.

Была сделана попытка отправить несколько заголовков ответа.

`ERR_HTTP2_INFO_STATUS_NOT_ALLOWED`¶

Информационные коды состояния HTTP (1xx) не может быть установлен в качестве кода состояния ответа в ответах HTTP / 2.

Заголовки соединения HTTP / 1 запрещено использовать в запросах и ответах HTTP / 2.

Указано недопустимое значение заголовка HTTP / 2.

`ERR_HTTP2_INVALID_INFO_STATUS`¶

Указан недопустимый информационный код состояния HTTP. Информационные коды состояния должны быть целыми числами между 100 а также 199 (включительно).

`ERR_HTTP2_INVALID_ORIGIN`¶

HTTP / 2 ORIGIN кадры требуют действительного происхождения.

`ERR_HTTP2_INVALID_PACKED_SETTINGS_LENGTH`¶

Вход Buffer а также Uint8Array экземпляры переданы в http2.getUnpackedSettings() API должен иметь длину, кратную шести.

Только допустимые псевдозаголовки HTTP / 2 (:status, :path, :authority, :scheme, а также :method) может быть использовано.

`ERR_HTTP2_INVALID_SESSION`¶

Действие было выполнено с Http2Session объект, который уже был уничтожен.

`ERR_HTTP2_INVALID_SETTING_VALUE`¶

Для параметра HTTP / 2 указано недопустимое значение.

`ERR_HTTP2_INVALID_STREAM`¶

Операция была выполнена над потоком, который уже был уничтожен.

`ERR_HTTP2_MAX_PENDING_SETTINGS_ACK`¶

Всякий раз, когда HTTP / 2 SETTINGS фрейм отправляется подключенному одноранговому узлу, одноранговый узел должен отправить подтверждение, что он получил и применил новый SETTINGS. По умолчанию максимальное количество неподтвержденных SETTINGS кадры могут быть отправлены в любой момент времени. Этот код ошибки используется при достижении этого предела.

`ERR_HTTP2_NESTED_PUSH`¶

Была сделана попытка инициировать новый push-поток из push-потока. Вложенные push-потоки не разрешены.

`ERR_HTTP2_NO_MEM`¶

Недостаточно памяти при использовании http2session.setLocalWindowSize(windowSize) API.

`ERR_HTTP2_NO_SOCKET_MANIPULATION`¶

Была предпринята попытка напрямую манипулировать (чтение, запись, пауза, возобновление и т. Д.) Сокетом, подключенным к Http2Session.

`ERR_HTTP2_ORIGIN_LENGTH`¶

HTTP / 2 ORIGIN кадры ограничены длиной 16382 байта.

`ERR_HTTP2_OUT_OF_STREAMS`¶

Количество потоков, созданных в одном сеансе HTTP / 2, достигло максимального предела.

`ERR_HTTP2_PAYLOAD_FORBIDDEN`¶

Полезная нагрузка сообщения была указана для кода ответа HTTP, для которого полезная нагрузка запрещена.

`ERR_HTTP2_PING_CANCEL`¶

Пинг HTTP / 2 был отменен.

`ERR_HTTP2_PING_LENGTH`¶

Полезные данные ping HTTP / 2 должны иметь длину ровно 8 байтов.

Псевдозаголовок HTTP / 2 использован ненадлежащим образом. Псевдо-заголовки — это имена ключей заголовков, которые начинаются с : приставка.

`ERR_HTTP2_PUSH_DISABLED`¶

Была сделана попытка создать push-поток, который был отключен клиентом.

`ERR_HTTP2_SEND_FILE`¶

Была сделана попытка использовать Http2Stream.prototype.responseWithFile() API для отправки каталога.

`ERR_HTTP2_SEND_FILE_NOSEEK`¶

Была сделана попытка использовать Http2Stream.prototype.responseWithFile() API для отправки чего-то другого, кроме обычного файла, но offset или length были предоставлены варианты.

`ERR_HTTP2_SESSION_ERROR`¶

В Http2Session закрывается с ненулевым кодом ошибки.

`ERR_HTTP2_SETTINGS_CANCEL`¶

В Http2Session настройки отменены.

`ERR_HTTP2_SOCKET_BOUND`¶

Была сделана попытка подключить Http2Session возражать против net.Socket или tls.TLSSocket который уже был привязан к другому Http2Session объект.

`ERR_HTTP2_SOCKET_UNBOUND`¶

Была сделана попытка использовать socket собственность Http2Session это уже было закрыто.

`ERR_HTTP2_STATUS_101`¶

Использование 101 Информационный код статуса запрещен в HTTP / 2.

`ERR_HTTP2_STATUS_INVALID`¶

Указан недопустимый код состояния HTTP. Коды состояния должны быть целыми числами между 100 а также 599 (включительно).

`ERR_HTTP2_STREAM_CANCEL`¶

An Http2Stream был уничтожен до того, как какие-либо данные были переданы подключенному узлу.

`ERR_HTTP2_STREAM_ERROR`¶

Ненулевой код ошибки был указан в RST_STREAM Рамка.

`ERR_HTTP2_STREAM_SELF_DEPENDENCY`¶

При установке приоритета для потока HTTP / 2 этот поток может быть помечен как зависимость для родительского потока. Этот код ошибки используется, когда делается попытка пометить поток и зависит от него самого.

`ERR_HTTP2_TOO_MANY_INVALID_FRAMES`¶

Предел приемлемых недопустимых кадров протокола HTTP / 2, отправленных партнером, как указано в maxSessionInvalidFrames вариант, был превышен.

`ERR_HTTP2_TRAILERS_ALREADY_SENT`¶

Конечные заголовки уже отправлены на Http2Stream.

`ERR_HTTP2_TRAILERS_NOT_READY`¶

В http2stream.sendTrailers() метод не может быть вызван до тех пор, пока 'wantTrailers' событие испускается на Http2Stream объект. В 'wantTrailers' событие будет сгенерировано только в том случае, если waitForTrailers опция установлена для Http2Stream.

`ERR_HTTP2_UNSUPPORTED_PROTOCOL`¶

http2.connect() был передан URL-адрес, использующий любой протокол, кроме http: или https:.

`ERR_ILLEGAL_CONSTRUCTOR`¶

Была предпринята попытка построить объект с использованием закрытого конструктора.

`ERR_INCOMPATIBLE_OPTION_PAIR`¶

Пара опций несовместима друг с другом и не может использоваться одновременно.

`ERR_INPUT_TYPE_NOT_ALLOWED`¶

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

В --input-type Флаг использовался для попытки выполнить файл. Этот флаг можно использовать только при вводе через --eval, --print или STDIN.

`ERR_INSPECTOR_ALREADY_ACTIVATED`¶

При использовании inspector module была предпринята попытка активировать инспектор, когда он уже начал прослушивать порт. Использовать inspector.close() прежде чем активировать его на другом адресе.

`ERR_INSPECTOR_ALREADY_CONNECTED`¶

При использовании inspector модуль, была предпринята попытка подключения, когда инспектор уже был подключен.

`ERR_INSPECTOR_CLOSED`¶

При использовании inspector модуля, была предпринята попытка использовать инспектор после того, как сессия уже закрылась.

`ERR_INSPECTOR_COMMAND`¶

Произошла ошибка при подаче команды через inspector модуль.

`ERR_INSPECTOR_NOT_ACTIVE`¶

В inspector не активен, когда inspector.waitForDebugger() называется.

`ERR_INSPECTOR_NOT_AVAILABLE`¶

В inspector модуль недоступен для использования.

`ERR_INSPECTOR_NOT_CONNECTED`¶

При использовании inspector модуль, была предпринята попытка использовать инспектор до его подключения.

`ERR_INSPECTOR_NOT_WORKER`¶

В основном потоке был вызван API, который можно использовать только из рабочего потока.

`ERR_INTERNAL_ASSERTION`¶

Ошибка в Node.js или некорректное использование внутренних компонентов Node.js. Чтобы исправить ошибку, откройте проблему на https://github.com/nodejs/node/issues.

`ERR_INVALID_ADDRESS_FAMILY`¶

Указанное семейство адресов не распознается API Node.js.

`ERR_INVALID_ARG_TYPE`¶

В API Node.js был передан аргумент неправильного типа.

`ERR_INVALID_ARG_VALUE`¶

Для данного аргумента было передано недопустимое или неподдерживаемое значение.

`ERR_INVALID_ASYNC_ID`¶

Недействительный asyncId или triggerAsyncId был передан с использованием AsyncHooks. Идентификатор меньше -1 никогда не должен происходить.

`ERR_INVALID_BUFFER_SIZE`¶

Обмен был произведен на Buffer но его размер был несовместим с операцией.

`ERR_INVALID_CALLBACK`¶

Требовалась функция обратного вызова, но она не была предоставлена API Node.js.

`ERR_INVALID_CHAR`¶

В заголовках обнаружены недопустимые символы.

`ERR_INVALID_CURSOR_POS`¶

Курсор в данном потоке нельзя переместить в указанную строку без указанного столбца.

`ERR_INVALID_FD`¶

Дескриптор файла (‘fd’) недействителен (например, имеет отрицательное значение).

`ERR_INVALID_FD_TYPE`¶

Недопустимый тип дескриптора файла (‘fd’).

`ERR_INVALID_FILE_URL_HOST`¶

API-интерфейс Node.js, который потребляет file: URL-адреса (например, определенные функции в fs module) обнаружил URL-адрес файла с несовместимым хостом. Эта ситуация может возникнуть только в Unix-подобных системах, где только localhost или поддерживается пустой хост.

`ERR_INVALID_FILE_URL_PATH`¶

API-интерфейс Node.js, который потребляет file: URL-адреса (например, определенные функции в fs module) обнаружил URL-адрес файла с несовместимым путем. Точная семантика для определения возможности использования пути зависит от платформы.

`ERR_INVALID_HANDLE_TYPE`¶

Была сделана попытка отправить неподдерживаемый «дескриптор» по каналу связи IPC дочернему процессу. Видеть subprocess.send() а также process.send() для дополнительной информации.

`ERR_INVALID_HTTP_TOKEN`¶

Предоставлен недопустимый токен HTTP.

`ERR_INVALID_IP_ADDRESS`¶

IP-адрес недействителен.

`ERR_INVALID_MODULE`¶

Была сделана попытка загрузить несуществующий или недействительный модуль.

`ERR_INVALID_MODULE_SPECIFIER`¶

Строка импортированного модуля является недопустимым URL-адресом, именем пакета или указателем подпути пакета.

`ERR_INVALID_PACKAGE_CONFIG`¶

Недействительный package.json файл не прошел синтаксический анализ.

`ERR_INVALID_PACKAGE_TARGET`¶

В package.json "exports" Поле содержит недопустимое значение сопоставления цели для попытки разрешения модуля.

`ERR_INVALID_PERFORMANCE_MARK`¶

При использовании Performance Timing API (perf_hooks), отметка о производительности недействительна.

`ERR_INVALID_PROTOCOL`¶

Недействительный options.protocol был передан http.request().

`ERR_INVALID_REPL_EVAL_CONFIG`¶

Оба breakEvalOnSigint а также eval параметры были установлены в REPL config, который не поддерживается.

`ERR_INVALID_REPL_INPUT`¶

Вход не может использоваться в REPL. Условия, при которых используется эта ошибка, описаны в REPL документация.

`ERR_INVALID_RETURN_PROPERTY`¶

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

`ERR_INVALID_RETURN_PROPERTY_VALUE`¶

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

`ERR_INVALID_RETURN_VALUE`¶

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

`ERR_INVALID_STATE`¶

Указывает, что операция не может быть завершена из-за недопустимого состояния. Например, объект может быть уже уничтожен или может выполнять другую операцию.

`ERR_INVALID_SYNC_FORK_INPUT`¶

А Buffer, TypedArray, DataView или string был предоставлен как вход stdio для асинхронной вилки. См. Документацию по child_process модуль для получения дополнительной информации.

`ERR_INVALID_THIS`¶

Функция API Node.js была вызвана с несовместимым this ценить.

const urlSearchParams = new URLSearchParams(
  'foo=bar&baz=new'
);

const buf = Buffer.alloc(1);
urlSearchParams.has.call(buf, 'foo');
// Throws a TypeError with code 'ERR_INVALID_THIS'

`ERR_INVALID_TRANSFER_OBJECT`¶

Недопустимый объект передачи был передан в postMessage().

`ERR_INVALID_TUPLE`¶

Элемент в iterable предоставлен WHATWG URLSearchParams конструктор не представлял [name, value] кортеж — то есть, если элемент не повторяется или не состоит ровно из двух элементов.

`ERR_INVALID_URI`¶

Передан неверный URI.

`ERR_INVALID_URL`¶

Недействительный URL был передан в WHATWG URL конструктор или наследие url.parse() быть разобранным. Выброшенный объект ошибки обычно имеет дополнительное свойство 'input' который содержит URL-адрес, который не удалось проанализировать.

`ERR_INVALID_URL_SCHEME`¶

Была сделана попытка использовать URL несовместимой схемы (протокола) для определенной цели. Он используется только в WHATWG URL API поддержка в fs модуль (который принимает только URL-адреса с 'file' схема), но может использоваться и в других API Node.js в будущем.

`ERR_IPC_CHANNEL_CLOSED`¶

Была сделана попытка использовать канал связи IPC, который уже был закрыт.

`ERR_IPC_DISCONNECTED`¶

Была сделана попытка отключить уже отключенный канал связи IPC. См. Документацию по child_process модуль для получения дополнительной информации.

`ERR_IPC_ONE_PIPE`¶

Была предпринята попытка создать дочерний процесс Node.js, использующий более одного канала связи IPC. См. Документацию по child_process модуль для получения дополнительной информации.

`ERR_IPC_SYNC_FORK`¶

Была предпринята попытка открыть канал связи IPC с помощью синхронно разветвленного процесса Node.js. См. Документацию по child_process модуль для получения дополнительной информации.

`ERR_MANIFEST_ASSERT_INTEGRITY`¶

Была предпринята попытка загрузить ресурс, но ресурс не соответствовал целостности, определенной в манифесте политики. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MANIFEST_DEPENDENCY_MISSING`¶

Была предпринята попытка загрузить ресурс, но ресурс не был указан как зависимость от расположения, в котором его пытались загрузить. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MANIFEST_INTEGRITY_MISMATCH`¶

Была сделана попытка загрузить манифест политики, но в манифесте было несколько записей для ресурса, которые не совпадали друг с другом. Обновите записи манифеста, чтобы они соответствовали, чтобы устранить эту ошибку. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MANIFEST_INVALID_RESOURCE_FIELD`¶

Ресурс манифеста политики имел недопустимое значение для одного из полей. Обновите запись манифеста, чтобы она соответствовала, чтобы устранить эту ошибку. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MANIFEST_INVALID_SPECIFIER`¶

Ресурс манифеста политики имел недопустимое значение для одного из сопоставлений зависимостей. Обновите запись манифеста, чтобы она соответствовала разрешению этой ошибки. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MANIFEST_PARSE_POLICY`¶

Была предпринята попытка загрузить манифест политики, но не удалось проанализировать манифест. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MANIFEST_TDZ`¶

Была предпринята попытка чтения из манифеста политики, но инициализация манифеста еще не произошла. Вероятно, это ошибка в Node.js.

`ERR_MANIFEST_UNKNOWN_ONERROR`¶

Манифест политики был загружен, но для его поведения «onerror» было неизвестно значение. Документацию для политика манифесты для получения дополнительной информации.

`ERR_MEMORY_ALLOCATION_FAILED`¶

Была предпринята попытка выделить память (обычно на уровне C ++), но она не удалась.

`ERR_MESSAGE_TARGET_CONTEXT_UNAVAILABLE`¶

Сообщение отправлено MessagePort не удалось десериализовать в целевой vm Context. Не все объекты Node.js могут быть успешно созданы в любом контексте в настоящее время, и попытки передать их с помощью postMessage() в этом случае может выйти из строя принимающая сторона.

`ERR_METHOD_NOT_IMPLEMENTED`¶

Метод требуется, но не реализован.

`ERR_MISSING_ARGS`¶

Не был передан обязательный аргумент API Node.js. Это используется только для строгого соответствия спецификации API (которая в некоторых случаях может принимать func(undefined) но нет func()). В большинстве собственных API-интерфейсов Node.js func(undefined) а также func() рассматриваются одинаково, а ERR_INVALID_ARG_TYPE вместо этого можно использовать код ошибки.

`ERR_MISSING_OPTION`¶

Для API-интерфейсов, которые принимают объекты параметров, некоторые параметры могут быть обязательными. Этот код выдается, если отсутствует необходимая опция.

`ERR_MISSING_PASSPHRASE`¶

Была сделана попытка прочитать зашифрованный ключ без указания ключевой фразы.

`ERR_MISSING_PLATFORM_FOR_WORKER`¶

Платформа V8, используемая этим экземпляром Node.js, не поддерживает создание рабочих. Это вызвано отсутствием поддержки Embedder для Workers. В частности, эта ошибка не возникает при использовании стандартных сборок Node.js.

`ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST`¶

Объект, который должен быть явно указан в transferList аргумент находится в объекте, переданном в postMessage() звоните, но не указано в transferList для этого звонка. Обычно это MessagePort.

В версиях Node.js до v15.0.0 использованный здесь код ошибки был ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST. Однако набор переносимых типов объектов был расширен, чтобы охватить больше типов, чем MessagePort.

`ERR_MODULE_NOT_FOUND`¶

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

An Модуль ES не может быть решен.

`ERR_MULTIPLE_CALLBACK`¶

Обратный звонок был вызван более одного раза.

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

`ERR_NAPI_CONS_FUNCTION`¶

При использовании Node-API, переданный конструктор не является функцией.

`ERR_NAPI_INVALID_DATAVIEW_ARGS`¶

Во время звонка napi_create_dataview(), данный offset находился за пределами окна просмотра данных или offset + length был больше, чем длина заданного buffer.

`ERR_NAPI_INVALID_TYPEDARRAY_ALIGNMENT`¶

Во время звонка napi_create_typedarray()предоставленные offset не был кратен размеру элемента.

`ERR_NAPI_INVALID_TYPEDARRAY_LENGTH`¶

Во время звонка napi_create_typedarray(), (length * size_of_element) + byte_offset был больше, чем длина заданного buffer.

`ERR_NAPI_TSFN_CALL_JS`¶

Произошла ошибка при вызове части JavaScript поточно-ориентированной функции.

`ERR_NAPI_TSFN_GET_UNDEFINED`¶

Произошла ошибка при попытке получить код JavaScript. undefined ценить.

`ERR_NAPI_TSFN_START_IDLE_LOOP`¶

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

`ERR_NAPI_TSFN_STOP_IDLE_LOOP`¶

Если в очереди больше не осталось элементов, цикл простоя должен быть приостановлен. Эта ошибка указывает на то, что не удалось остановить цикл холостого хода.

`ERR_NO_CRYPTO`¶

Была предпринята попытка использовать функции шифрования, пока Node.js не был скомпилирован с поддержкой шифрования OpenSSL.

`ERR_NO_ICU`¶

Была предпринята попытка использовать функции, требующие ICU, но Node.js не был скомпилирован с поддержкой ICU.

`ERR_NON_CONTEXT_AWARE_DISABLED`¶

Родной аддон, не зависящий от контекста, был загружен в процессе, который их запрещает.

`ERR_OUT_OF_RANGE`¶

Заданное значение выходит за пределы допустимого диапазона.

`ERR_PACKAGE_IMPORT_NOT_DEFINED`¶

В package.json "imports" поле не определяет заданное отображение спецификатора внутреннего пакета.

`ERR_PACKAGE_PATH_NOT_EXPORTED`¶

В package.json "exports" не экспортирует запрошенный подпуть. Поскольку экспорт инкапсулирован, частные внутренние модули, которые не экспортируются, не могут быть импортированы через разрешение пакета, если не используется абсолютный URL-адрес.

`ERR_PERFORMANCE_INVALID_TIMESTAMP`¶

Для отметки производительности или показателя было предоставлено недопустимое значение метки времени.

`ERR_PERFORMANCE_MEASURE_INVALID_OPTIONS`¶

Предусмотрены недопустимые варианты измерения производительности.

`ERR_PROTO_ACCESS`¶

Доступ Object.prototype.__proto__ было запрещено использовать --disable-proto=throw. Object.getPrototypeOf а также Object.setPrototypeOf следует использовать для получения и установки прототипа объекта.

`ERR_REQUIRE_ESM`¶

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

Была сделана попытка require() ан Модуль ES.

`ERR_SCRIPT_EXECUTION_INTERRUPTED`¶

Выполнение скрипта было прервано SIGINT (Например, Ctrl+C был нажат.)

`ERR_SCRIPT_EXECUTION_TIMEOUT`¶

Истекло время выполнения сценария, возможно, из-за ошибок в выполняемом сценарии.

`ERR_SERVER_ALREADY_LISTEN`¶

В server.listen() метод был вызван в то время как net.Server уже слушал. Это относится ко всем экземплярам net.Server, включая HTTP, HTTPS и HTTP / 2 Server экземпляры.

`ERR_SERVER_NOT_RUNNING`¶

В server.close() метод был вызван, когда net.Server не работал. Это относится ко всем экземплярам net.Server, включая HTTP, HTTPS и HTTP / 2 Server экземпляры.

`ERR_SOCKET_ALREADY_BOUND`¶

Была сделана попытка привязать уже связанный сокет.

`ERR_SOCKET_BAD_BUFFER_SIZE`¶

Был передан недопустимый (отрицательный) размер для recvBufferSize или sendBufferSize варианты в dgram.createSocket().

`ERR_SOCKET_BAD_PORT`¶

Функция API, ожидающая порта> = 0 и <65536, получила недопустимое значение.

`ERR_SOCKET_BAD_TYPE`¶

Функция API, ожидающая типа сокета (udp4 или udp6) получил недопустимое значение.

`ERR_SOCKET_BUFFER_SIZE`¶

При использовании dgram.createSocket(), размер получения или отправки Buffer не может быть определено.

`ERR_SOCKET_CLOSED`¶

Была сделана попытка работать с уже закрытым сокетом.

`ERR_SOCKET_DGRAM_IS_CONNECTED`¶

А dgram.connect() вызов был сделан на уже подключенном сокете.

`ERR_SOCKET_DGRAM_NOT_CONNECTED`¶

А dgram.disconnect() или dgram.remoteAddress() звонок был сделан на отключенной розетке.

`ERR_SOCKET_DGRAM_NOT_RUNNING`¶

Был сделан вызов, но подсистема UDP не работала.

`ERR_SRI_PARSE`¶

Строка была предоставлена для проверки целостности подресурса, но не может быть проанализирована. Проверьте формат атрибутов целостности, посмотрев на Спецификация целостности подресурсов.

`ERR_STREAM_ALREADY_FINISHED`¶

Был вызван метод потока, который не может быть завершен, поскольку поток был завершен.

`ERR_STREAM_CANNOT_PIPE`¶

Была сделана попытка позвонить stream.pipe() на Writable транслировать.

`ERR_STREAM_DESTROYED`¶

Был вызван метод потока, который не может быть завершен, поскольку поток был уничтожен с использованием stream.destroy().

`ERR_STREAM_NULL_VALUES`¶

Была сделана попытка позвонить stream.write() с null кусок.

`ERR_STREAM_PREMATURE_CLOSE`¶

Ошибка, возвращенная stream.finished() а также stream.pipeline(), когда поток или конвейер завершаются некорректно, без явной ошибки.

`ERR_STREAM_PUSH_AFTER_EOF`¶

Была сделана попытка позвонить stream.push() после null(EOF) был отправлен в поток.

`ERR_STREAM_UNSHIFT_AFTER_END_EVENT`¶

Была сделана попытка позвонить stream.unshift() после 'end' событие было отправлено.

`ERR_STREAM_WRAP`¶

Предотвращает прерывание, если строковый декодер был установлен на Socket или если декодер находится в objectMode.

const Socket = require('net').Socket;
const instance = new Socket();

instance.setEncoding('utf8');

`ERR_STREAM_WRITE_AFTER_END`¶

Была сделана попытка позвонить stream.write() после stream.end() был вызван.

`ERR_STRING_TOO_LONG`¶

Была сделана попытка создать строку длиннее максимально допустимой.

`ERR_SYNTHETIC`¶

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

`ERR_SYSTEM_ERROR`¶

В процессе Node.js произошла неопределенная или неспецифическая системная ошибка. Объект ошибки будет иметь err.info свойство объекта с дополнительной информацией.

`ERR_TLS_CERT_ALTNAME_INVALID`¶

При использовании TLS имя хоста / IP-адрес однорангового узла не соответствует ни одному из subjectAltNames в его сертификате.

`ERR_TLS_DH_PARAM_SIZE`¶

При использовании TLS параметр, предлагаемый для алгоритма Диффи-Хеллмана (DH) протокол согласования ключей слишком мал. По умолчанию длина ключа должна быть больше или равна 1024 битам, чтобы избежать уязвимостей, хотя настоятельно рекомендуется использовать 2048 бит или больше для большей безопасности.

`ERR_TLS_HANDSHAKE_TIMEOUT`¶

Время ожидания подтверждения TLS / SSL истекло. В этом случае сервер также должен прервать соединение.

`ERR_TLS_INVALID_CONTEXT`¶

Контекст должен быть SecureContext.

`ERR_TLS_INVALID_PROTOCOL_METHOD`¶

Указанный secureProtocol метод недействителен. Он либо неизвестен, либо отключен, потому что небезопасен.

`ERR_TLS_INVALID_PROTOCOL_VERSION`¶

Допустимые версии протокола TLS: 'TLSv1', 'TLSv1.1', или 'TLSv1.2'.

`ERR_TLS_INVALID_STATE`¶

Сокет TLS должен быть подключен и надежно установлен. Перед продолжением убедитесь, что «безопасное» событие запущено.

`ERR_TLS_PROTOCOL_VERSION_CONFLICT`¶

Попытка установить протокол TLS minVersion или maxVersion конфликтует с попыткой установить secureProtocol явно. Используйте тот или иной механизм.

`ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED`¶

Не удалось установить подсказку идентификатора PSK. Подсказка может быть слишком длинной.

`ERR_TLS_RENEGOTIATION_DISABLED`¶

Была сделана попытка повторно согласовать TLS на экземпляре сокета с отключенным TLS.

`ERR_TLS_REQUIRED_SERVER_NAME`¶

При использовании TLS server.addContext() был вызван без указания имени хоста в первом параметре.

`ERR_TLS_SESSION_ATTACK`¶

Обнаружено чрезмерное количество повторных согласований TLS, что является потенциальным вектором атак типа «отказ в обслуживании».

`ERR_TLS_SNI_FROM_SERVER`¶

Была предпринята попытка выдать указание имени сервера из сокета на стороне сервера TLS, который действителен только для клиента.

`ERR_TRACE_EVENTS_CATEGORY_REQUIRED`¶

В trace_events.createTracing() требуется по крайней мере одна категория событий трассировки.

`ERR_TRACE_EVENTS_UNAVAILABLE`¶

В trace_events модуль не может быть загружен, потому что Node.js был скомпилирован с --without-v8-platform флаг.

`ERR_TRANSFORM_ALREADY_TRANSFORMING`¶

А Transform поток завершился, пока он все еще преобразовывался.

`ERR_TRANSFORM_WITH_LENGTH_0`¶

А Transform поток закончился с данными, все еще находящимися в буфере записи.

`ERR_TTY_INIT_FAILED`¶

Инициализация TTY не удалась из-за системной ошибки.

`ERR_UNAVAILABLE_DURING_EXIT`¶

Функция была вызвана в process.on('exit') обработчик, который не должен вызываться внутри process.on('exit') обработчик.

`ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET`¶

process.setUncaughtExceptionCaptureCallback() был вызван дважды, без предварительного сброса обратного вызова на null.

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

`ERR_UNESCAPED_CHARACTERS`¶

Получена строка, содержащая неэкранированные символы.

`ERR_UNHANDLED_ERROR`¶

Произошла необработанная ошибка (например, когда 'error' событие испускается EventEmitter но 'error' обработчик не зарегистрирован).

`ERR_UNKNOWN_BUILTIN_MODULE`¶

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

`ERR_UNKNOWN_CREDENTIAL`¶

Был передан несуществующий идентификатор группы или пользователя Unix.

`ERR_UNKNOWN_ENCODING`¶

В API передан неверный или неизвестный параметр кодировки.

`ERR_UNKNOWN_FILE_EXTENSION`¶

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

Была сделана попытка загрузить модуль с неизвестным или неподдерживаемым расширением файла.

`ERR_UNKNOWN_MODULE_FORMAT`¶

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

Была сделана попытка загрузить модуль с неизвестным или неподдерживаемым форматом.

`ERR_UNKNOWN_SIGNAL`¶

Неверный или неизвестный сигнал процесса был передан API, ожидающему действительного сигнала (например, subprocess.kill()).

`ERR_UNSUPPORTED_DIR_IMPORT`¶

import URL-адрес каталога не поддерживается. Вместо, Самостоятельная ссылка на пакет, используя его имя а также определить настраиваемый подпуть в "exports" поле package.json файл.

import './'; // unsupported
import './index.js'; // supported
import 'package-name'; // supported

`ERR_UNSUPPORTED_ESM_URL_SCHEME`¶

import со схемами URL, отличными от file а также data не поддерживается.

`ERR_VALID_PERFORMANCE_ENTRY_TYPE`¶

При использовании Performance Timing API (perf_hooks) допустимые типы записей производительности не найдены.

`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`¶

Обратный вызов динамического импорта не указан.

`ERR_VM_MODULE_ALREADY_LINKED`¶

Модуль, который пытались связать, не подходит для связывания по одной из следующих причин:

Он уже был связан (linkingStatus является 'linked')
Это связано (linkingStatus является 'linking')
Не удалось установить связь для этого модуля (linkingStatus является 'errored')

`ERR_VM_MODULE_CACHED_DATA_REJECTED`¶

В cachedData Параметр, переданный конструктору модуля, недопустим.

`ERR_VM_MODULE_CANNOT_CREATE_CACHED_DATA`¶

Кэшированные данные не могут быть созданы для модулей, которые уже были оценены.

`ERR_VM_MODULE_DIFFERENT_CONTEXT`¶

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

`ERR_VM_MODULE_LINKING_ERRORED`¶

Функция компоновщика вернула модуль, для которого не удалось выполнить связывание.

`ERR_VM_MODULE_LINK_FAILURE`¶

Модуль не удалось связать из-за сбоя.

`ERR_VM_MODULE_NOT_MODULE`¶

Выполненное значение обещания связывания не является vm.Module объект.

`ERR_VM_MODULE_STATUS`¶

Текущий статус модуля не позволяет выполнить эту операцию. Конкретный смысл ошибки зависит от конкретной функции.

`ERR_WASI_ALREADY_STARTED`¶

Экземпляр WASI уже запущен.

`ERR_WASI_NOT_STARTED`¶

Экземпляр WASI не запущен.

`ERR_WORKER_INIT_FAILED`¶

В Worker Ошибка инициализации.

`ERR_WORKER_INVALID_EXEC_ARGV`¶

В execArgv вариант передан в Worker конструктор содержит недопустимые флаги.

`ERR_WORKER_NOT_RUNNING`¶

Операция завершилась неудачно, потому что Worker экземпляр в настоящее время не запущен.

`ERR_WORKER_OUT_OF_MEMORY`¶

В Worker Экземпляр остановлен, поскольку достиг предела памяти.

`ERR_WORKER_PATH`¶

Путь для основного скрипта рабочего не является ни абсолютным, ни относительным путем, начинающимся с ./ или ../.

`ERR_WORKER_UNSERIALIZABLE_ERROR`¶

Все попытки сериализации неперехваченного исключения из рабочего потока завершились неудачно.

`ERR_WORKER_UNSUPPORTED_OPERATION`¶

Запрошенная функциональность не поддерживается в рабочих потоках.

`ERR_ZLIB_INITIALIZATION_FAILED`¶

Создание zlib сбой объекта из-за неправильной конфигурации.

Получено слишком много данных заголовка HTTP. Для защиты от злонамеренных или неправильно настроенных клиентов, если получено более 8 КБ данных HTTP-заголовка, анализ HTTP будет прерван без создания объекта запроса или ответа, и Error с этим кодом будет выпущен.

`HPE_UNEXPECTED_CONTENT_LENGTH`¶

Сервер отправляет как Content-Length заголовок и Transfer-Encoding: chunked.

Transfer-Encoding: chunked позволяет серверу поддерживать постоянное соединение HTTP для динамически генерируемого контента. В этом случае Content-Length Заголовок HTTP использовать нельзя.

Использовать Content-Length или Transfer-Encoding: chunked.

`MODULE_NOT_FOUND`¶

Не удалось разрешить файл модуля при попытке require() или import операция.

Устаревшие коды ошибок Node.js¶

Стабильность: 0 — Не рекомендуется. Эти коды ошибок либо несовместимы, либо были удалены.

`ERR_CANNOT_TRANSFER_OBJECT`¶

Значение, переданное в postMessage() содержит объект, который не поддерживается для передачи.

`ERR_CRYPTO_HASH_DIGEST_NO_UTF16`¶

Кодировка UTF-16 использовалась с hash.digest(). В то время как hash.digest() метод позволяет encoding аргумент, который должен быть передан, в результате чего метод возвращает строку, а не Buffer, кодировка UTF-16 (например, ucs или utf16le) не поддерживается.

`ERR_HTTP2_FRAME_ERROR`¶

Используется при сбое отправки отдельного кадра в сеансе HTTP / 2.

Используется, когда ожидается объект заголовков HTTP / 2.

Используется, когда в сообщении HTTP / 2 отсутствует требуемый заголовок.

Информационные заголовки HTTP / 2 должны отправляться только прежний позвонить в Http2Stream.prototype.respond() метод.

`ERR_HTTP2_STREAM_CLOSED`¶

Используется, когда действие было выполнено над уже закрытым потоком HTTP / 2.

`ERR_HTTP_INVALID_CHAR`¶

Используется, когда в сообщении статуса ответа HTTP (фраза причины) обнаружен недопустимый символ.

`ERR_INDEX_OUT_OF_RANGE`¶

Данный индекс был вне допустимого диапазона (например, отрицательные смещения).

`ERR_INVALID_OPT_VALUE`¶

В объект опций было передано недопустимое или неожиданное значение.

`ERR_INVALID_OPT_VALUE_ENCODING`¶

Передана неверная или неизвестная кодировка файла.

`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`¶

Этот код ошибки был заменен на ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST в Node.js v15.0.0, потому что он больше не точен, поскольку теперь существуют и другие типы переносимых объектов.

`ERR_NAPI_CONS_PROTOTYPE_OBJECT`¶

Используется Node-API когда Constructor.prototype не объект.

`ERR_NO_LONGER_SUPPORTED`¶

API Node.js был вызван неподдерживаемым способом, например Buffer.write(string, encoding, offset[, length]).

`ERR_OPERATION_FAILED`¶

Не удалось выполнить операцию. Обычно это используется, чтобы сигнализировать об общем сбое асинхронной операции.

`ERR_OUTOFMEMORY`¶

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

`ERR_PARSE_HISTORY_DATA`¶

В repl модулю не удалось проанализировать данные из файла истории REPL.

`ERR_SOCKET_CANNOT_SEND`¶

Данные не могут быть отправлены через сокет.

`ERR_STDERR_CLOSE`¶

Была сделана попытка закрыть process.stderr транслировать. По замыслу Node.js не позволяет stdout или stderr потоки должны быть закрыты кодом пользователя.

`ERR_STDOUT_CLOSE`¶

Была сделана попытка закрыть process.stdout транслировать. По замыслу Node.js не позволяет stdout или stderr потоки должны быть закрыты кодом пользователя.

`ERR_STREAM_READ_NOT_IMPLEMENTED`¶

Используется, когда делается попытка использовать читаемый поток, который не реализован readable._read().

`ERR_TLS_RENEGOTIATION_FAILED`¶

Используется, когда запрос на повторное согласование TLS завершился ошибкой неспецифическим образом.

`ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER`¶

А SharedArrayBuffer чья память не управляется механизмом JavaScript или Node.js. во время сериализации. Такой SharedArrayBuffer не может быть сериализован.

Это может произойти только тогда, когда нативные аддоны создают SharedArrayBuffers в «внешнем» режиме или поместите существующий SharedArrayBuffer во внешний режим.

`ERR_UNKNOWN_STDIN_TYPE`¶

Была предпринята попытка запустить процесс Node.js с неизвестным stdin тип файла. Эта ошибка обычно указывает на ошибку в самом Node.js, хотя пользовательский код может вызвать ее.

`ERR_UNKNOWN_STREAM_TYPE`¶

Была предпринята попытка запустить процесс Node.js с неизвестным stdout или stderr тип файла. Эта ошибка обычно указывает на ошибку в самом Node.js, хотя пользовательский код может вызвать ее.

`ERR_V8BREAKITERATOR`¶

V8 BreakIterator API использовался, но не установлен полный набор данных ICU.

`ERR_VALUE_OUT_OF_RANGE`¶

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

`ERR_VM_MODULE_NOT_LINKED`¶

Перед созданием экземпляра модуль должен быть успешно связан.

`ERR_WORKER_UNSUPPORTED_EXTENSION`¶

Имя пути, используемое для основного сценария рабочего, имеет неизвестное расширение файла.

`ERR_ZLIB_BINDING_CLOSED`¶

Используется, когда делается попытка использовать zlib объект после того, как он уже был закрыт.

`ERR_CPU_USAGE`¶

Родной звонок от process.cpuUsage не может быть обработано.

Источник

Table of Contents

What Is Error Handling in Node.js
Why Do You Need Error Handling
Types of Errors: Operational vs. Programmer Errors
Operational Errors
Programmer Errors
What Is an Error Object?
How Do You Handle Errors in Node.js: Best Practices You Should Follow
1. Use Custom Errors to Handle Operational Errors
2. Use a Middleware
3. Restart Your App Gracefully to Handle Programmer Errors
4. Catch All Uncaught Exceptions
5. Catch All Unhandled Promise Rejections
6. Use a Centralized Location for Logs and Error Alerting
How to Deliver Errors: Function Patterns
Throwing Errors
Using Callback
Using Promises
Using EventEmitter
Throw, Callback, Promises, or EventEmitter: Which Pattern Is the Best?
How to Write Functions for Efficient Error Handling
Log Management Tools You Can Use to Handle Errors in Node.js
Closing Thoughts

Don’t you hate it when you see an uncaughtException error pop up and crash your Node.js app?

Yeah… I feel you. Can anything be worse? Oh yeah, sorry, unhandledRejection I didn’t see you there. What a nightmare you are. 😬

I maintain all Node.js open-source repos at Sematext. A few of them can help you out with error handling, but more about that further down.

Here at Sematext, we take error handling seriously! I want to share a bit of that today.

I want to guide you through what I’ve learned so far about error handling in Node.js while working on open-source projects. Hopefully, it’ll help you improve your code, make it more robust, and ultimately help you step up your bug hunting, and help improve your general developer experience.

I don’t want you to have to stay up late and burn the midnight oil troubleshooting bugs. Ah! About that, here’s an epic song I really like!

What Is Error Handling in Node.js

I’ve heard a ton of my fellow developers say error handling in Node.js is way too hard. Well, I can’t lie. It’s not easy. But, I have to be fair and say it’s not that hard either once you set up centralized error handling.

What is an error anyhow? It’s a way to see bugs in your code. Following this logic, error handling is a way to find these bugs and solve them as quickly as humanly possible.

From this explanation, it’s obvious the hard part is setting up a good base for your error handling. It’s all about keeping you sane at the end of the day. Handling errors properly means developing a robust codebase and reducing development time by finding bugs and errors easily.

Why Do You Need Error Handling

Why? For your own sanity. You want to make bug fixing less painful. It helps you write cleaner code. It centralizes all errors and lets you enable alerting and notifications so you know when and how your code breaks.

Types of Errors: Operational vs. Programmer Errors

Would you believe me when I said not all errors are caused by humans? Don’t get me wrong, most still are, but not all of them! Errors can be Operational and Programmer errors.

Operational Errors

Operational errors represent runtime problems. These errors are expected in the Node.js runtime and should be dealt with in a proper way. This does not mean the application itself has bugs. It means they need to be handled properly. Here’s a list of common operational errors:

failed to connect to server
failed to resolve hostname
invalid user input
request timeout
server returned a 500 response
socket hang-up
system is out of memory

Programmer Errors

Programmer errors are what we call bugs. They represent issues in the code itself. Here’s a common one for Node.js, when you try reading a property of an undefined object. It’s a classic case of programmer error. Here are a few more:

called an asynchronous function without a callback
did not resolve a promise
did not catch a rejected promise
passed a string where an object was expected
passed an object where a string was expected
passed incorrect parameters in a function

Now you understand what types of errors you’ll be facing, and how they are different. Operational errors are part of the runtime and application while programmer errors are bugs you introduce in your codebase.

Now you’re thinking, why do we divide them into two categories? It’s simple really.

Do you want to restart your app if there’s a user not found error? Absolutely not. Other users are still enjoying your app. This is an example of an operational error.

What about failing to catch a rejected promise? Does it make sense to keep the app running even when a bug threatens your app? No! Restart it.

What Is an Error Object?

The error object is a built-in object in the Node.js runtime. It gives you a set of info about an error when it happens. The Node.js docs have a more in-depth explanation.

A basic error looks like this:

const error = new Error("An error message")
console.log(error.stack)

It has an error.stack field that gives you a stack trace showing where the error came from. It also lists all functions that were called before the error occurred. The error.stack field is optimal to use while debugging as it prints the error.message as well.

How Do You Handle Errors in Node.js: Best Practices You Should Follow

From my experience, there are a few best practices that will make it easier to handle errors in Node.js.

You can handle errors in callbacks. There are some serious drawbacks to using callbacks because it creates a nested “callback hell”. It’s notoriously hard to debug and fix errors if you need to look for them in nested functions.

A better way is to use async/await and try-catch statements, or .catch() errors in promises.

Let me show you what I mean.

1. Use Custom Errors to Handle Operational Errors

With the async/await pattern you can write code that looks synchronous, but actually is asynchronous.

const anAsyncTask = async () => {
 try {
 const user = await getUser()
 const cart = await getCart(user)

 return cart
 } catch (error) {
 console.error(error)
 } finally {
 await cleanUp()
 }
}

This pattern will clean up your code and avoid the dreaded callback hell.

You can use the built-in Error object in Node.js as I mentioned above, as it gives you detailed info about stack traces.

However, I also want to show you how to create custom Error objects with more meaningful properties like HTTP status codes and more detailed descriptions.

Here’s a file called baseError.js where you set the base for every custom error you’ll use.

// baseError.js

class BaseError extends Error {
 constructor (name, statusCode, isOperational, description) {
 super(description)

 Object.setPrototypeOf(this, new.target.prototype)
 this.name = name
 this.statusCode = statusCode
 this.isOperational = isOperational
 Error.captureStackTrace(this)
 }
}

module.exports = BaseError

Also create an httpStatusCodes.js file to keep a map of all status codes you want to handle.

// httpStatusCodes.js

const httpStatusCodes = {
 OK: 200,
 BAD_REQUEST: 400,
 NOT_FOUND: 404,
 INTERNAL_SERVER: 500
}

module.exports = httpStatusCodes

Then, you can create an api404Error.js file, and extend the BaseError with a custom error for handling 404s.

// api404Error.js

const httpStatusCodes = require('./httpStatusCodes')
const BaseError = require('./baseError')

class Api404Error extends BaseError {
 constructor (
 name,
 statusCode = httpStatusCodes.NOT_FOUND,
 description = 'Not found.',
 isOperational = true
 ) {
 super(name, statusCode, isOperational, description)
 }
}

module.exports = Api404Error

How do you use it? Throw it in your code when you want to handle 404 errors.

const Api404Error = require('./api404Error')

...
const user = await User.getUserById(req.params.id)
if (user === null) {
 throw new Api404Error(`User with id: ${req.params.id} not found.`)
}
...

You can duplicate this code for any custom error, 500, 400, and any other you want to handle.

2. Use a Middleware

Once you have a set of custom errors, you can configure centralized error handling. You want to have a middleware that catches all errors. There you can decide what to do with them and where to send them if they need to notify you via an alert notification.

In your API routes you’ll end up using the next() function to forward errors to the error handler middleware.

Let me show you.

...
app.post('/user', async (req, res, next) => {
 try {
const newUser = User.create(req.body)
 } catch (error) {
 next(error)
 }
})
...

The next() function is a special function in Express.js middlewares that sends values down the middleware chain. At the bottom of your routes files you should have a .use() method that uses the error handler middleware function.

const { logError, returnError } = require('./errorHandler')

app.use(logError)
app.use(returnError)

The error handler middleware should have a few key parts. You should check if the error is operational, and decide which errors to send as alert notifications so you can debug them in more detail. Here’s what I suggest you add to your error handler.

function logError (err) {
 console.error(err)
}

function logErrorMiddleware (err, req, res, next) {
 logError(err)
 next(err)
}

function returnError (err, req, res, next) {
 res.status(err.statusCode || 500).send(err.message)
}

function isOperationalError(error) {
 if (error instanceof BaseError) {
 return error.isOperational
 }
 return false
}

module.exports = {
 logError,
 logErrorMiddleware,
 returnError,
 isOperationalError
}

3. Restart Your App Gracefully to Handle Programmer Errors

Everything I’ve explained so far has been related to operational errors. I’ve shown how to gracefully handle expected errors and how to send them down the middleware chain to a custom error handling middleware.

Let’s jump into programmer errors now. These errors can often cause issues in your apps like memory leaks and high CPU usage. The best thing to do is to crash the app and restart it gracefully by using the Node.js cluster mode or a tool like PM2. I wrote another article where I describe in detail how to detect Node.js memory leaks using various solutions.

4. Catch All Uncaught Exceptions

When unexpected errors like these happen, you want to handle it immediately by sending a notification and restarting the app to avoid unexpected behavior.

const { logError, isOperationalError } = require('./errorHandler')

...
process.on('uncaughtException', error => {
 logError(error)

 if (!isOperationalError(error)) {
 process.exit(1)
 }
})
...

5. Catch All Unhandled Promise Rejections

Promise rejections in Node.js only cause warnings. You want them to throw errors, so you can handle them properly.

It’s good practice to use fallback and subscribe to:

process.on('unhandledRejection', callback)

This lets you throw an error properly.

Here’s what the error handling flow should look like.

...
const user = User.getUserById(req.params.id)
 .then(user => user)
 // missing a .catch() block
...

// if the Promise is rejected this will catch it
process.on('unhandledRejection', error => {
 throw error
})

process.on('uncaughtException', error => {
 logError(error)

 if (!isOperationalError(error)) {
 process.exit(1)
 }
})

6. Use a Centralized Location for Logs and Error Alerting

I recently wrote a detailed tutorial about Node.js logging best practices you should check out.

The gist of it is to use structured logging to print errors in a formatted way and send them for safekeeping to a central location, like Sematext Logs, our log management tool.

It’ll help with your sanity and persist the logs over time, so you can go back and troubleshoot issues whenever things break.

To do this, you should use loggers like winston and morgan. Additionally, you can add winston-logsene to send the logs to Sematext right away.

First, create a setup for winston and winston-logsene. Create a loggers directory and a logger.js file. Paste this into the file.

// logger.js

const winston = require('winston')
const Logsene = require('winston-logsene')

const options = {
 console: {
 level: 'debug',
 handleExceptions: true,
 json: false,
 colorize: true
 },
 logsene: {
 token: process.env.LOGS_TOKEN,
 level: 'debug',
 type: 'app_logs',
 url: 'https://logsene-receiver.sematext.com/_bulk'
 }
}

const logger = winston.createLogger({
 levels: winston.config.npm.levels,
 transports: [
 new winston.transports.Console(options.console),
 new Logsene(options.logsene)
 ],
 exitOnError: false
})

module.exports = logger

The good thing with this is that you get JSON formatted logs you can analyze to get more useful information about your app. You’ll also get all logs forwarded to Sematext. This will alert you whenever errors occur. That’s pretty awesome!

Furthermore, you should add an httpLogger.js file in the loggers directory and add morgan and morgan-json to print out access logs. Paste this into the httpLogger.js:

const morgan = require('morgan')
const json = require('morgan-json')
const format = json({
 method: ':method',
 url: ':url',
 status: ':status',
 contentLength: ':res[content-length]',
 responseTime: ':response-time'
})

const logger = require('./logger')
const httpLogger = morgan(format, {
 stream: {
 write: (message) => {
 const {
 method,
 url,
 status,
 contentLength,
 responseTime
 } = JSON.parse(message)

 logger.info('HTTP Access Log', {
 timestamp: new Date().toString(),
 method,
 url,
 status: Number(status),
 contentLength,
 responseTime: Number(responseTime)
 })
 }
 }
})

module.exports = httpLogger

In your app.js file you can now require both the logger.js and httpLogger.js, and use the logger instead of console.log().

// app.js

const logger = require('./loggers/logger')
const httpLogger = require('./loggers/httpLogger')
...

app.use(httpLogger)
...

In your errorHandler.js you can now replace all console.error() statements with logger.error() to persist the logs in Sematext.

// errorHandler.js

const logger = require('../loggers/logger')
const BaseError = require('./baseError')

function logError (err) {
 logger.error(err)
}

function logErrorMiddleware (err, req, res, next) {
 logError(err)
 next(err)
}

function returnError (err, req, res, next) {
 res.status(err.statusCode || 500).send(err.message)
}

function isOperationalError(error) {
 if (error instanceof BaseError) {
 return error.isOperational
 }
 return false
}

module.exports = {
 logError,
 logErrorMiddleware,
 returnError,
 isOperationalError
}

That’s it. You now know how to properly handle errors!

However, I do want to cover how to deliver errors. Should you be throwing them, passing errors in callback functions or promise rejections, or emit an “error” event via an EventEmitter.

How to Deliver Errors: Function Patterns

Let’s go over the four main ways to deliver an error in Node.js:

throw the error (making it an exception).
pass the error to a callback, a function provided specifically for handling errors and the results of asynchronous operations
pass the error to a reject Promise function
emit an “error” event on an EventEmitter

We’ve talked about how to handle errors, but when you’re writing a new function, how do you deliver errors to the code that called your function?

Throwing Errors

When you throw an error it unwinds the entire function call stack ignoring any functions you have on the stack. It gets delivered synchronously, in the same context where the function was called.

If you use a try-catch block you can handle the error gracefully. Otherwise, the app usually crashes, unless you have a fallback for catching Uncaught Exceptions as I explained above.

Here’s an example of throwing an error and handling it in a try-catch block:

const getUserWithAsyncAwait = async (id) => {
 try {
 const user = await getUser(id)
 if (!user) {
 throw new 404ApiError('No user found.')
 }

 return user
 } catch (error) {
 // handle the error
 logError(error)
 }
}

const user = await getUserWithAsyncAwait(1)

...

Using Callback

Callbacks are the most basic way of delivering an error asynchronously. The user passes you a function – the callback, and you invoke it sometime later when the asynchronous operation completes. The usual pattern is that the callback is invoked as callback(err, result), where only one of err and result is non-null, depending on whether the operation succeeded or failed.

Callbacks have been around for ages. It’s the oldest way of writing asynchronous JavaScript code. It’s also the oldest way of delivering errors asynchronously.

You pass a callback function as a parameter to the calling function, which you later invoke when the asynchronous function completes executing.

The usual pattern looks like this:

callback(err, result)

The first parameter in the callback is always the error.

Inside the callback function, you’ll then first check if the error exists and only if it’s a non-null value you continue executing the callback function.

function getUserWithCallback(id, callback) {
 getUser(id, function(user) {
 if (!user) {
 return callback(new 404ApiError('No user found.'))
 }

 callback(null, user)
 })
}

getUserWithCallback(1, function(err, user) {
 if (err) {
 // handle the error
 logError(error)
 }

 const user = user
 ...
})

Using Promises

Promises have replaced callbacks as the new and improved way of writing asynchronous code.

This pattern has become the new norm since Node.js version 8 that included async/await out of the box. Asynchronous code can be written to look like synchronous code. Catch errors can be done by using try-catch.

function getUserWithPromise(id) {
 return new Promise((resolve, reject) => {
 getUser(id, function(user) {
 if (!user) {
 return reject(new 404ApiError('No user found.'))
 }

 resolve(user)
 })
 })
}

getUserWithPromise(1)
 .then(user => {
 const user = user
 ...
 })
 .catch(err => {
 logError(error)
 })

Using EventEmitter

Ready for some more complicated use cases?

In some cases, you can’t rely on promise rejection or callbacks. What if you’re reading files from a stream. Or, fetching rows from a database and reading them as they arrive. A use case I see on a daily basis is streaming log lines and handling them as they’re coming in.

You can’t rely on one error because you need to listen for error events on the EventEmitter object.

In this case, instead of returning a Promise, your function would return an EventEmitter and emit row events for each result, an end event when all results have been reported, and an error event if any error is encountered.

Here’s a code sample from Logagent, an open-source log shipper I maintain. The socket value is an EventEmitter object.

net.createServer(socket => {
...

 socket
 .on('data', data => {
 ...

 })
 .on('end', result => {
 …

 })
 .on('error', console.error) // handle multiple errors
}

Throw, Callback, Promises, or EventEmitter: Which Pattern Is the Best?

Now, we’ve finally come to the verdict, when should you throw errors, and when do you use promise rejections or EventEmitters?

For operational errors, you should use Promise rejections or a try-catch block with async/await. You want to handle these errors asynchronously. It works well and is widely used.

If you have a more complicated case like I explained above, you should use an event emitter instead.

You want to explicitly throw errors if unwinding the whole call stack is needed. This can mean when handling programmer errors and you want the app to restart.

How to Write Functions for Efficient Error Handling

Whatever you do, choose one way to deliver operational errors. You can throw errors and deliver them synchronously, or asynchronously by using Promise rejections, passing them in callbacks, or emitting errors on an EventEmitter.

After setting up centralized error handling, the next logical step is to use a central location for your logs that also gives you error alerting.

Sematext Logs provides log management and error alerting to help analyze logs and debug and fix errors and exceptions. Definitely check it out and try it yourself. But you can also take a look at the lists where we compare the best log management tools, log analysis software, and cloud logging services available today.

Closing Thoughts

In this tutorial, I wanted to give you a way to handle the dreaded unhandledException and unhandledRejection errors in Node.js apps. I hope it was useful to you and that you’ll use what you learned today in your own apps.

Alongside this, I also explained a few best practices about error handling, like how to set up centralized error handling with middlewares and use a central location for your error logs. Don’t forget that logging frameworks like winston and morgan are crucial for this to work.

Lastly, I explained a few different ways of delivering errors, either with throw or with Promise .reject(), callback functions or the .on(‘error’) event on an EventEmitter.

I’ve tried to share all the knowledge I’ve gained over the last few years while maintaining open-source repos to keep you from making the same mistakes I’ve made in the past. Best of luck!

If you ever need alerting, error handling, and log management for your production apps, check us out.

Источник

Что такое ошибки в Node.js

Как обработать ошибку

Исключения

Колбэк с первым аргументом-ошибкой

Отклонение обещаний

Источники событий

Расширение объекта ошибки

Типы ошибок

Операционные ошибки

Ошибки программиста

Обработка операционных ошибок

Сообщить об ошибке в стек

Повторить операцию

Отправить ошибку клиенту

Прервать программу.

Предотвращение ошибок программиста

Принять TypeScript

Определить поведение для неверных параметров

Автоматизированное тестирование

Неперехваченные исключения и необработанные отклонения обещаний

Анатомия Объекта Error

Ключевое слово Throw

Бросаем исключения на примере

Стек вызовов

Как называть функции

Обработка асинхронных исключений

Мы разберемся с этой ошибкой, обещаю!

Отлавливать или не отлавливать?

Риски асинхронного try/catch

Заключение

Материалы по теме

Что такое ошибки в Node.js

Как устранить ошибки

1. Исключения

2. Обратные вызовы с ошибкой

3. Отказ от промисов

4. Генераторы событий

Расширение объекта ошибки

Типы ошибок

1. Операционные ошибки

2. Ошибки программиста

Оперативная обработка ошибок

1. Сообщите об ошибке вверх по стеку

2. Повторите операцию

3. Отправить ошибку клиенту

4. Прервать программу

Предотвращение ошибок программиста

1. Примите TypeScript

2. Определите поведение для неверных параметров

3. Автоматизированное тестирование

Неперехваченные исключения и необработанные отказы от промисов

Централизованная отчетность об ошибках

1. Установите пакет

2. Импортируйте библиотеку

3. Сообщите об ошибках

Резюме

Вывод

Error propagation and interception

Error-first callbacks

Class: Error

new Error(message[, options])

Error.captureStackTrace(targetObject[, constructorOpt])

Error.stackTraceLimit

error.cause

error.code

error.message

error.stack

Class: AssertionError

Class: RangeError

Class: ReferenceError

Class: SyntaxError

Class: SystemError

error.address

error.code

error.dest

error.errno

error.info

error.message

error.path

error.port

Class: `Error`

`new Error(message[, options])`

`Error.captureStackTrace(targetObject[, constructorOpt])`

`Error.stackTraceLimit`

`error.cause`

`error.code`

`error.message`

`error.stack`

Class: `AssertionError`

Class: `RangeError`

Class: `ReferenceError`

Class: `SyntaxError`

Class: `SystemError`

`error.address`

`error.code`

`error.dest`

`error.errno`

`error.info`

`error.message`

`error.path`

`error.port`

`error.syscall`

Class: `TypeError`

`error.opensslErrorStack`

`error.function`

`error.library`

`error.reason`

`ABORT_ERR`

`ERR_AMBIGUOUS_ARGUMENT`

`ERR_ARG_NOT_ITERABLE`

`ERR_ASSERTION`

`ERR_ASYNC_CALLBACK`

`ERR_ASYNC_TYPE`

`ERR_BROTLI_COMPRESSION_FAILED`

`ERR_BROTLI_INVALID_PARAM`

`ERR_BUFFER_CONTEXT_NOT_AVAILABLE`

`ERR_BUFFER_OUT_OF_BOUNDS`

`ERR_BUFFER_TOO_LARGE`

`ERR_CANNOT_WATCH_SIGINT`

`ERR_CHILD_CLOSED_BEFORE_REPLY`

`ERR_CHILD_PROCESS_IPC_REQUIRED`

`ERR_CHILD_PROCESS_STDIO_MAXBUFFER`

`ERR_CLOSED_MESSAGE_PORT`

`ERR_CONSOLE_WRITABLE_STREAM`

`ERR_CONSTRUCT_CALL_INVALID`

`ERR_CONSTRUCT_CALL_REQUIRED`

`ERR_CONTEXT_NOT_INITIALIZED`

`ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED`

`ERR_CRYPTO_ECDH_INVALID_FORMAT`

`ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY`

`ERR_CRYPTO_ENGINE_UNKNOWN`

`ERR_CRYPTO_FIPS_FORCED`

`ERR_CRYPTO_FIPS_UNAVAILABLE`

`ERR_CRYPTO_HASH_FINALIZED`

`ERR_CRYPTO_HASH_UPDATE_FAILED`

`ERR_CRYPTO_INCOMPATIBLE_KEY`

`ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS`

`ERR_CRYPTO_INITIALIZATION_FAILED`

`ERR_CRYPTO_INVALID_AUTH_TAG`

`ERR_CRYPTO_INVALID_COUNTER`

`ERR_CRYPTO_INVALID_CURVE`

`ERR_CRYPTO_INVALID_DIGEST`

`ERR_CRYPTO_INVALID_IV`

`ERR_CRYPTO_INVALID_JWK`

`ERR_CRYPTO_INVALID_KEY_OBJECT_TYPE`

`ERR_CRYPTO_INVALID_KEYLEN`

`ERR_CRYPTO_INVALID_KEYPAIR`

`ERR_CRYPTO_INVALID_KEYTYPE`

`ERR_CRYPTO_INVALID_MESSAGELEN`

`ERR_CRYPTO_INVALID_SCRYPT_PARAMS`

`ERR_CRYPTO_INVALID_STATE`

`ERR_CRYPTO_INVALID_TAG_LENGTH`

`ERR_CRYPTO_JOB_INIT_FAILED`

`ERR_CRYPTO_JWK_UNSUPPORTED_CURVE`

`ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE`

`ERR_CRYPTO_OPERATION_FAILED`

`ERR_CRYPTO_PBKDF2_ERROR`

`ERR_CRYPTO_SCRYPT_INVALID_PARAMETER`

`ERR_CRYPTO_SCRYPT_NOT_SUPPORTED`

`ERR_CRYPTO_SIGN_KEY_REQUIRED`