Javascript ошибка соединения

Время на прочтение
22 мин

Количество просмотров 69K

Пост содержит перевод статьи «Error Handling in Node.js», которую подготовили сотрудники компании Joyent. Статья была опубликована 28 марта 2014 года на сайте компании. Dave Pacheco поясняет, что статья призвана устранить неурядицу среди разработчиков, касаемо лучших практик работы с ошибками в Node.js, а так же ответить на вопросы, которые часто возникают у начинающих разработчиков.

Обработка ошибок в Node.js

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

У начинающих разработчиков часто возникают следующие вопросы:

  • Можно ли использовать throw, что бы вернуть ошибку из функции или следует вызывать callback-функцию передав объект ошибки в качестве аргумента? В каких случаях необходимо генерировать событие 'error' у объекта класса EventEmitter?
  • Нужно ли производить проверку аргументов переданных функции? Что, если в функцию переданы некорректные аргументы? Нужно ли в таком случае генерировать исключение или вызывать callback-функцию, передавая ей ошибку?
  • Возможно ли программно различать ошибки по типу, что бы приложение могло соответствующим образом обрабатывать ошибки согласно их типу (например, «Bad Request» или «Service Unavailable»)?
  • Как функция может наиболее информативно «сообщить» программе о возникновении ошибки, чтобы та могла корректно её обработать?
  • Нужно ли обрабатывать ошибки вызванные «багами» в программе?


Данная статья состоит из семи частей:

  1. Введение. О том, что читатель должен знать перед ознакомлением со статьей.
  2. Программные ошибки и ошибки программиста. Ознакомление с типами ошибок.
  3. Шаблоны написания функций. Основополагающие принципы написания функций, реализующих корректную работу с ошибками.
  4. Правила написания функций. Перечень указаний которым следует придерживаться при написании функций.
  5. Пример. Пример написания функции.
  6. Резюме. Краткое представление основных положений рассмотренных в статье.
  7. Приложение. Общепринятые имена полей объектов ошибок.

1. Введение

Предполагается, что читатель:

  • знаком с термином «исключение» в JavaScript, Java, Python, C++, или другом подобном языке и понимает принцип работы конструкции try/catch;
  • знаком с разработкой на Node.js и освоил принципы асинхронного программирования.

Читатель должен понимать, почему в представленном ниже коде не работает перехват исключений, несмотря на наличие конструкции try/catch.1

function myFunc(callback)
{
  /*
   * Пример некорректного перехвата исключений
   */
  try {
    doSomeAsyncOperation(function (err) {
      if (err) {
        throw (err);
      }
    });
  } catch (ex) {
    callback(ex);
  }
}

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

  1. Бросание ошибки throw (генерирование исключения).
  2. Вызов callback-функции с объектом ошибки в качестве первого аргумента.
  3. Генерирование события 'error' у объекта класса EventEmitter.

Предполагается, что читатель не знаком с доменами в Node.js.

Читатель должен понимать разницу между ошибкой и исключением в JavaScript. Ошибка — это любой объект класса Error. Ошибка может быть создана конструктором класса и возвращена из функции либо брошена с помощью инструкции ThrowStatement. Когда объект ошибки брошен, возникает исключение. Далее приведён пример бросания ошибки (генерирование исключения):2

throw new Error('произошла ошибка');

Пример, где ошибка передаётся в callback-функцию:

callback(new Error('произошла ошибка'));

Второй вариант чаще встречается в Node.js, из-за асинхронности большинства выполняемых операций. Как правило, первый вариант используется лишь при десериализации данных (например, JSON.parse), при этом брошенное исключение перехватывается с помощью конструкции try/catch. Это отличает Node.js от Java или C++ и других языков, где приходится чаще работать с исключениями.

2. Программные ошибки и ошибки программиста

Ошибки можно условно разделить на два типа:3

  • Программные ошибки представляют собой конфликты, возникающие в ходе нормального функционирования программы. Они не являются «багами». Обычно, они не связаны напрямую с программой: системные ошибки (например, переполнение памяти), ошибки конфигураций (например, неверно указан адрес удалённого сервера), ошибки интернет-соединения или ошибки возникшие на удалённом сервере.
    Примеры программных ошибок:

    • пользователь ввёл некорректные данные,
    • истекло время ожидания ответа на запрос (request timeout),
    • сервер ответил на запрос ошибкой с кодом 500,
    • разрыв соединения,
    • израсходована выделенная память.

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

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

Возможны случаи, когда по одной и той же причине возникают как программная ошибка, так и ошибка программиста. Предположим, HTTP-сервер производит попытку считать какое-либо поле у значения undefined, что является ошибкой программиста. В результате, сервер выходит из строя. Клиент, при этом, в качестве ответа на свой запрос получает ошибку ECONNRESET, обычно описываемую Node.js как: «socket hang-up». Для клиента, это программная ошибка и корректно написанная программа-клиент соответствующим образом обработает ошибку и продолжит работу.

Отсутствие обработчика программной ошибки является ошибкой программиста. Предположим, что программа-клиент, устанавливая соединение с сервером, сталкивается с ECONNREFUSED ошибкой, в результате, объект соединения генерирует событие 'error', но для данного события не зарегистрирована ни одна функция-обработчик, по этой причине программа выходит из строя. В данном случае, ошибка соединения является программной ошибкой, однако, отсутствие обработчика для события ‘error’ объекта соединения — ошибка программиста.

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

Обработка программных ошибок

Обработка программных ошибок, так же как и вопросы безопасности или производительности приложения, не относится к тому типу задач, которые могут быть решены внедрением какого-либо модуля — невозможно в одном месте исходного кода решить все проблемы связанные с обработкой ошибок. Для решения задачи обработки ошибок требуется децентрализованный подход. Для всех участков программы, где возможно возникновение ошибки (обращение к файловой системе, соединение с удалённым сервером, создание дочернего процесса и т.д.) необходимо предписать соответствующие сценарии обработки для каждого возможного типа ошибки. Значит, необходимо не только выделить проблемные участки, но и понять каких типов ошибки могут в них возникнуть.

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

Выделим возможные сценарии обработки ошибок:

  • Устранение ошибки. Иногда, возникшую ошибку можно устранить. Предположим, возникла ошибка ENOENT, при попытке записать информацию в лог-файл. Это может означать, что программа запущена впервые и лог-файл еще не создан. В таком случае, обработчик может устранить ошибку, создав искомый файл. Приведём более интересный пример: программе необходимо постоянно поддерживать соединение с определённым севером (например, с базой данных), но в ходе работы возник разрыв соединения. В этом случае обработчик ошибки может произвести переподключение к базе данных.
  • Информирование пользователя и прекращение обработки запроса. Если нельзя решить возникшую проблему, проще всего прервать работу текущей операции, и сообщить пользователю об ошибке. Данный сценарий применим в случаях, когда известно, что причина, по которой возникла ошибка, не исчезнет с течением времени. К примеру, если ошибка возникла при попытке десериализации JSON-данных, переданных клиентом, то нет смысла повторять попытку с этими же данными.
  • Повторение операции. В случае ошибок связанных с работой по сети может помочь повторный запуск операции. Предположим, программа в ответ на запрос к удалённому сервису получила в ответе ошибку 503 (Service Unavailable error), в таком случае, возможно, стоит повторить запрос спустя несколько секунд. Важно определить конечное число повторов, а так же, с какой периодичностью должны выполняться попытки. Но не следует всегда полагаться на данный сценарий. Предположим, пользователь выполнил запрос к некоторому сервису, которому для обработки запроса потребовалось обратиться к вашей программе, а ваша программа, в свою очередь, осуществляет запрос к еще одному сервису, который ответил ошибкой 503. В этом случае, лучшим решением будет не выполнять повторных попыток, а незамедлительно дать возможность обработать ошибку исходному сервису, с которым работает пользователь. Если каждый сервис, участвующий в цепочке запросов, будет производить повторные попытки, то пользователь будет ожидать ответ на свой запрос дольше чем, если бы их выполнял только исходный сервис.
  • Прекращение работы программы. Если произошла непредвиденная ситуация, появление которой невозможно при нормальном функционировании программы, следует записать информацию об ошибке в соответствующий лог-файл и прекратить работу. Данный сценарий может быть использован, если ваша программа израсходовала доступную память (однако, если ваша программа получила ошибку ENOMEM от дочернего процесса, то ошибку можно обработать и не прекращать работу программы). Так же, данный сценарий можно применить если у вашей программы нет прав доступа к необходимым для работы файлам.
  • Запись ошибки в лог-файл и продолжение работы. В некоторых случаях нет необходимости прекращать работу программы даже если возникшая ошибка неустранима. В пример можно привести ситуацию, когда ваша программа периодически обращается к группе удалённых сервисов через систему DNS, и один из сервисов «выпал» из DNS. В данной ситуации программа может продолжить работу с оставшимися сервисами. Но, тем не менее, необходимо записать об ошибке в лог-файл. (Для любого правила всегда есть исключения, если ошибка возникает тысячу раз в секунду, и вы не можете ничего с ней поделать, то не нужно каждый раз выполнять запись в лог, однако, стоит периодически производить логирвоание.)

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

Не существует правильного способа обрабатывать ошибки программиста. По определению, если возникла такая ошибка, то код программы некорректен. Устранить проблему можно лишь исправив код.

Есть программисты считающие, что в некоторых случаях можно восстанавливать программу после произошедшей ошибки таким образом, что текущая операция прерывается, но программа, тем не менее, продолжает работать и обрабатывать другие запросы. Так поступать не рекомендуется. Принимая во внимание то, что ошибка программиста вводит программу в нестабильное состояние, можете ли вы быть уверены в том, что возникшая ошибка не нарушит работу других запросов? Если запросы работают с одними и теми же сущностями (например, сервер, сокет, соединения с базой данных и т.д.), остаётся лишь надеется, что последующие запросы будут правильно обработаны.

Рассмотрим REST-сервис (реализованный, например, с помощью модуля restify). Предположим, что один из обработчиков запросов бросил исключение RefferenceError из-за того, что программист сделал опечатку в имени переменной. Если немедленно не прекратить работу сервиса, может возникнуть ряд проблем, которые бывает сложно отследить:

  • Если какая-то сущность в результате опечатки оказалась равна null или undefined, то последующие запросы, обратившись к ней, так же, бросят исключения и не будут обработаны.
  • Если функция, которая бросила исключение, работала с базой данных, может произойти утечка соединия. Каждый раз, когда подобная ошибка будет повторяться, число соединений, используя которые сервис может работать с базой данных, будет уменьшаться.
  • Более сложная ситуация может произойти, если в качестве базы данных используется postgres, и соединение осталось незакрытым в ходе выполнения транзакции. В этом случае, «повисшая» транзакция не даст очищать старые версии записей, которые для неё видны. Транзакция может оставаться открытой неделями. Размер, который таблица занимает в памяти, будет расти без ограничений, что приведёт к тому, что обработка последующих запросов будет замедляться.4 Конечно, данный пример достаточно специфичен и касается лишь postgres, однако, он отлично иллюстрирует, что опасно продолжать работу программы, которая пребывает в нестабильном состоянии.
  • Соединение к удалённому сервису может остаться с незакрытой сессией, вследствие чего, следующий запрос может быть обработан от лица не того пользователя.
  • Может остаться незакрытым сокет. По умолчанию Node.js закроет неактивный сокет через две минуты, но это поведение может быть переопределено, и если ошибка будет повторяться, то в итоге число возможных сокетов будет исчерпано. Если вы оставите конфигурации по умолчанию, отследить и исправить проблему будет тяжело, так как ошибка о неактивном сокете возникает с задержкой в две минуты.
  • Может возникнуть утечка памяти, которая приведёт к её переполнению и выходу программы из строя. Или еще хуже — утечка может усложнить процесс сборки мусора, из-за чего начнет страдать производительность программы. Обнаружить причину проблемы в таком случае будет особенно затруднительно.

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

  • Сбои вызванные ошибкой программиста вводят приложение в нестабильное состояние. Нужно стремиться к тому, чтобы таких ошибок не возникало, их устранение имеет наивысший приоритет.
  • После перезапуска запросы могут как выполняться корректно, так и снова привести к ошибке. Может случиться так, что запросы обрабатываются некорректно, но отследить проблему сложно.
  • В хорошо спроектированной системе, независимо от того вызвана ли ошибка проблемой с интернет-соединением или ошибка произошла в Node.js, программа-клиент должна уметь обрабатывать ошибки сервера (переподключаться, выполнять повторные запросы).

Если перезапуск программы происходит очень часто, то следует отлаживать код и устранять ошибки. Лучшим способом для отладки будет сохранение и анализ снимка ядра. Данный подход работает как в GNU/Linux-системах, так и в illumos-системах, и позволяет просмотреть не только последовательность функций, которые привели к ошибке, но и переданные им аргументы, а так же состояние других объектов, видимых через замыкания.

3. Шаблоны написания функций

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

Throw, callback или EventEmitter?

Существует три основных способа вернуть ошибку из функции:

  1. throw возвращает ошибку синхронно. Это значит, что исключение возникнет в том же контексте, в котором функция была вызвана. Если используется try/catch, то исключение будет поймано. В противном случае — программа выйдет из строя (если, конечно, исключение не отловит домен или обработчик события 'uncaughtException' глобального объекта process, такой вариант будет рассмотрен далее).
  2. Вызов callback-функции с объектом ошибки в качестве первого аргумента является наиболее часто используемым способом вернуть ошибку из асинхронной функции. Общепринятым шаблоном вызова callback-функции является вызов вида callback(err, results), где только один из аргументов может принимать значения отличные от null.
  3. В более сложных случаях функция может генерировать событие 'error' объекта класса EventEmitter, тогда ошибка будет обработана, если зарегистрирован обработчик для события 'error'. Данный вариант используется если:
    • производится комплексная операция, которая возвращает несколько результатов или ошибок. Примером может быть извлечение записей из базы данных. Функция возвращает объект класса EventEmitter и вызывает событие 'row' — при извлечении каждой записи, "end" — когда все записи извлечены и 'error' — если возникает ошибка.
    • объект представляет собой сложный автомат, производящий множество асинхронных операций. В пример можно привести сокет, вызывающий события 'connect', 'end', 'timeout', 'drain' и 'close'. При возникновении ошибки, объект будет генерировать событие 'error'. Используя данный подход важно понимать, в каких ситуациях может возникать ошибка, могут ли при этом возникать и другие события и в каком порядке они возникают.

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

Итак, когда же использовать throw, а когда использовать callback-функции или события? Это зависит от двух факторов:

  • типа ошибки (ошибка программиста или программная ошибка),
  • типа функции в которой возникла ошибка (асинхронная или синхронная).

Программные ошибки характерны в большей мере для асинхронных функций. Асинхронные функции принимают в качестве аргумента callback-функцию, при возникновении ошибки она вызвается с объектом ошибки в качестве аргумента. Такой подход отлично себя зарекомендовал и широко применяется. В качестве примера можно ознакомиться с Node.js модулем fs. Событийный подход так же используется, но уже в более сложных случаях.

Программные ошибки в синхронных функциях могут возникать, как правило, если функция работает с данными, введёнными пользователем (например JSON.parse). В таких функциях при возникновении ошибки бросается исключение, реже – объект ошибки возвращается оператором return.

Если в функции хотя бы одна из возможных ошибок асинхронна, то все возможные ошибки должны возвращаться из функции используя асинхронный подход. Даже если ошибка возникла в том же контексте, в котором была вызвана функция, объект ошибки следует вернуть асинхронно.

Есть важное правило: для возврата ошибок в одной и той же функции может быть реализован либо синхронный, либо асинхронный подход, но никогда и тот и другой вместе. Тогда, чтобы принимать у функции ошибку, нужно будет использовать либо callback-функцию (или функцию-обработчик события 'error'), либо конструкцию try/catch, но никогда и то и другое. В документации к функции следует указывать, какой из способов к ней применим.

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

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

Рассмотренные рекомендации представлены в таблице:

Пример функции Тип функции Ошибка Тип ошибки Как возвращать Как обрабатывать
fs.stat асинхронная файл не найден программная callback функция-обработчик
JSON.parse синхронная ошибка ввода программная throw try/catch
fs.stat асинхронная отсутствует обязательный аргумент ошибка программиста throw не обрабатывается
(прекращение работы)

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

Ошибка ввода: ошибка программиста или программная ошибка?

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

Вам предстоит решать с какой строгостью производить проверку аргументов. Представим некую функцию connect, котороя принимает IP-адрес и callback-функцию в качестве аргументов. Предположим, что был произведён вызов этой функции с аргументом отличающимся по формату от IP-адреса, например: «bob». Рассмотрим что может произойти в таком случае:

  • Если вы строго производите проверку, соответствует ли формат введённой строки формату IPv4 адреса, то ваша функция бросит исключение на этапе проверки аргументов. Такой сценарий является наиболее приемлимым.
  • Если же вы проверяете лишь тип аргументов, то возникнет асинхронная ошибка о том, что невозможно подключиться к IP-адресу «bob».

Оба варианта удовлетворяют рассмотренным рекомендациям и вам решать насколько строго производить проверку. Функция Date.parse, например, принимает аргументы различных форматов, но на то есть причины. Всё же, для большинства функций рекомендуется строго проверять переданные аргументы. Чем более расплывчаты критерии проверки аргументов, тем более затруднительным становится процесс отладки кода. Как правило, чем строже проверка – тем лучше. И даже если в будущих версиях программы вы вдруг смягчите критерии проверки внутри какой-то функции, то вы не рискуете сломать ваш код.

Если переданное значение не удовлетворяет требованиям (например, undefined или строка имеет неверный формат), то функция должна сообщать о том, что переданное значение некорректно и прекращать работу программы. Прекращая работу программы, сообщив о некорректных аргументах, вы упрощаете процесс отладки кода себе и другим программистам.

Домены и process.on(‘uncaughtException’)

Программные ошибки всегда могут быть отловлены по определённому механизму: через try/catch, в callback-функции или обработчиком события 'error'. Домены и событие глобального объекта process 'uncaughtException' часто используются для перестраховки от непредвиденных ошибок, которые мог допустить программист. Учитывая рассмотренные выше положения, данный подход настоятельно не рекомендуется.

4. Правила написания функций

При написании функций придерживайтесь следующих правил:

  1. Пишите подробную документацию
    Это самое важное правило. Документация к функции должна содержать информацию:

    • о том с какими аргументами работает функция;
    • о том каких типов должны быть аргументы;
    • о любых дополнительных ограничениях, которые накладываются на вид аргументов (пример: IP-адрес должен иметь корректный формат).

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

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

  2. Используйте объекты класса Error (или подклассов) для всех ошибок.
    Все ваши ошибки должны быть объектами класса Error или классов, которые являются его наследниками. Используйте поля name и message, поле stack так же должно корректно работать.
  3. Расширяйте объект ошибки полями, которые описывают подробности ошибки.
    Если в функцию был передан некорректный аргумент, задайте в объекте ошибки поля propertyName и propertyValue. Для ошибок подключения к удалённому серверу расширяйте объект ошибки полем remoteIp, чтобы указать к какому адресу не удалось подключиться. При возникновении системной ошибки включайте в объект ошибки поле syscall, поясняющее, какой системный вызов не был обработан, так же включите поле errno , содержащее информацию о типе системной ошибки. В приложении к статье описаны рекомендуемые имена полей.

    Ошибка обязательно должна содержать корректные поля:

    • name: используется обработчиками для дифференциации ошибок по типу.
    • message: текст описывающий возникшую проблему. Текст должен быть коротким, но достаточно ёмким, что бы можно было понять суть проблемы.
    • stack: никогда не изменяйте объект стэка вызовов. V8 производит построение этого объекта только тогда, когда к нему производится обращение и процесс построения достаточно ресурсоёмкий, обращение к этому полю существенно снижает производительность программы.

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

  4. Если ошибка возвращается с низкого уровня вложенности функций, то следует оборачивать её.
    В начале статьи упоминалось, что возможна ситуация, когда приходится возвращать ошибку из функции, в которой она возникла через callback-функцию на уровень выше, а затем еще выше, до тех пор пока она не достигнет логического уровня приложения, который ответственен за обработку данного типа ошибок. В таких случаях рекомендуется производить обёртку ошибки по мере её «всплытия». Обёрткой функции называется расширение исходного объекта ошибки информацией о логическом уровне через который она была передана. Модуль verror позволяет реализовать такой механизм.
    Рассмотрим некую функцию fetchConfig, извлекающую настройки из удалённой базы данных. Вызов fetchConfig выполняется при старте работы сервиса. Алгоритм работы функции описан ниже.

        1. Извлечение настроек
          1.1 Соединение с базой данных
            1.1.1 Получение адреса через систему DNS
            1.1.2 Создание TCP соединения с сервером базы данных
            1.1.3 Аутентификация на сервере базы данных
          1.2. Выполнение запроса к базе данных
          1.3. Обработка результата запроса
          1.4. Настройка сервиса
        2. Запуск работы сервиса
        

    Предположим, что в пункте 1.1.2 возникла ошибка. Если передавать ошибку в контекст из которого была вызвана функция fetchConfig не оборачивая её, то сообщение об ошибке будет иметь вид:

    myserver: Error: connect ECONNREFUSED
    

    Пользы от такого сообщения мало.
    Далее представлено сообщение о той же ошибке, но с применением обёртки:

    myserver: failed to start up: failed to load configuration: failed to connect to
    database server: failed to connect to 127.0.0.1 port 1234: connect ECONNREFUSED
    

    Если не выполнять обёртку на некоторых уровнях, то можно получить более лаконичное сообщение:

    myserver: failed to load configuration: connection refused from database at
    127.0.0.1 port 1234.
    

    Однако, как правило, избыток информации — лучше чем дефицит.

    Есть несколько нюансов о которых нужно знать, если вы решили оборачивать свои ошибки:

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

    В Joyent мы используем модуль verror для обёртки ошибок, так как он имеет минималистичный синтаксис. На момент написания статьи в модуле не реализованы некоторые из рассмотренных рекомендаций, однако он будет дорабатываться.

5. Пример

Рассмотрим в качестве примера функцию, которая создаёт TCP соединение по указанному IPv4 адресу.

/*
 * Функция создаёт TCP соединение по указанному IPv4 адресу.  Аргументы:
 *
 *    ip4addr        строка адреса формата IPv4;
 *
 *    tcpPort        натуральное число, TCP порт;
 *
 *    timeout        натуральное число, время в миллисекундах, в течение которого
 *                   необходимо ждать ответа от удалённого сервера;
 *
 *    callback       функция вызываемая после завершения операции,
 *                   если операция завершилась успешно, происходит 
 *                   вызов вида callback(null, socket), где socket это
 *                   объект класса net.Socket, если возникла ошибка,
 *                   выполняется вызов вида callback(err).
 *
 * В функции могут возникнуть ошибки следующих типов:
 *
 *    SystemError    Для "connection refused", "host unreachable" и других
 *                   ошибок, возвращаемых системным вызовом connect(2). Для
 *                   данного типа ошибок поле errno объекта err будет содержать
 *                   соответствующее ошибке символьное представление.
 *
 *    TimeoutError   Данный тип ошибок возникает при истечении 
 *                   времени ожидания timeout.
 *
 * Все возвращаемые объекты ошибок имеют поля "remoteIp" и "remotePort".
 * После возникновении ошибки, сокеты, которые были открыты функцией, будут закрыты.
 */
function connect(ip4addr, tcpPort, timeout, callback)
{
  assert.equal(typeof (ip4addr), 'string',
      "аргумент 'ip4addr' должен быть строкового типа");
  assert.ok(net.isIPv4(ip4addr),
      "аргумент 'ip4addr' должен содержать IPv4 адрес");
  assert.equal(typeof (tcpPort), 'number',
      "аргумент 'tcpPort' должен быть числового типа");
  assert.ok(!isNaN(tcpPort) && tcpPort > 0 && tcpPort < 65536,
      "аргумент 'tcpPort' должен быть натуральным числом в диапазоне от 1 до 65535");
  assert.equal(typeof (timeout), 'number',
      "аргумент 'timeout' должен быть числового типа");
  assert.ok(!isNaN(timeout) && timeout > 0,
      "аргумент 'timeout' должен быть натуральным числом");
  assert.equal(typeof (callback), 'function');

  /* код функции */
}

Этот пример достаточно примитивен, но он иллюстрирует многие из рассмотренных рекомендаций:

  • Аргументы, их типы, и предъявляемые к ним требования подробно документированы.
  • Функция проверяет переданные ей аргументы и бросает исключение, если аргументы не удовлетворяют критериям.
  • Документированы типы возможных ошибок, а так же поля, которые они содержат.
  • Указан способ, которым функция возвращает ошибки.
  • Возвращаемые ошибки имеют поля «remoteIp» и «remotePort», что позволит обработчику на основе этой информации формировать сообщение ошибки.
  • Документировано состояние соединений после возникновения ошибки: «после возникновении ошибки, сокеты которые были открыты функцией, будут закрыты».

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

6. Резюме

  • Различайте ошибки программиста и программные ошибки.
  • Програмные ошибки могут и должны обрабатываться, тогда как ошибки программиста не могут быть корректно обработаны. Не следует продолжать работу программы в случае возникновения ошибок программиста, так как дальнейшее поведение программы непредсказуемо.
  • Для возврата ошибок в функции может быть реализован синхронный подход (например, throw) или асинхронный подход (callback-функция или событие), но нельзя реализовывать оба подхода в одной функции. Тогда, при использовании функции, чтобы обрабатывать возникающие в ней ошибки, нужно будет применять либо callback-функции, либо конструкцию try/catch, но никогда и то и другое.
  • При написании функций подробно документируйте аргументы, их типы, предъявляемые к ним требования, а так же типы возможных ошибок и то, как функция возвращает ошибки (синхронно, используя throw, или асинхронно, используя callback-функцию или событийный подход).
  • Возвращаемая ошибка должна быть объектом класса Error или класса-наследника. Расширяйте объект ошибки новыми полями, чтобы включить в объект необходимую информацию об ошибке. По возможности используйте общепринятые имена полей, представленные в приложении.

7. Приложение: общепринятые имена полей ошибок

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

Имя поля объекта ошибки Значение поля
localHostname локальное DNS-имя (например, то, по которому принимаются соединения)
localIp локальный IP-адрес (например, тот, по которому принимаются соединения)
localPort локальный TCP порт (например, тот, по которому принимаются соединения)
remoteHostname DNS-имя удалённого сервера (например, сервера, с которым устанавливается соединение)
remoteIp IP-адрес удалённого сервера (например, сервера, с которым устанавливается соединение)
remotePort порт удалённого сервера (например, сервера, с которым устанавливается соединение)
path путь к файлу, директории иди сокет межпроцессного взаимодействия (IPC-сокет) (например, путь к файлу, который необходимо считать)
srcpath путь используемый в качестве источника (например, для копирования фала)
dstpath путь назначения (например, для копирования фала)
hostname DNS имя (например, то, которое используется для попытки получить IP-адрес)
ip IP-адрес (например, тот, для которого производится попытка получить DNS-имя)
propertyName имя свойста объекта или имя аргумента (например, в ошибке, возникшей при проверке аргументов переданных в функцию)
propertyValue значение поля объекта (например, в ошибке, возникшей при проверке аргументов переданных в функцию)
syscall имя невыполненного системного вызова
errno символьное представление errno (например, "ENOENT")


1 Начинающие разработчики часто допускают подобную ошибку. В данном примере try/catch и вызов функции бросающей исключение выполнятся в разных контекстах из-за асинхронности функции doSomeAsyncOperation, поэтому исключение не будет поймано.
2 В JavaScript throw может работать со значениями и других типов, но рекомендуется использовать именно объекты класса Error. Если в ThrowStatement использовать другие значения, то будет невозможно получить стэк вызовов, который привел к ошибке, что усложнит отладку кода.
3 Данные понятия возникли задолго до появления Node.js. В Java аналогом можно считать проверяемые и непроверяемые исключения. В C для работы с ошибками программиста предусмотрены утверждения.
4 Приведённый пример может показаться слишком предметным, это потому, что он не вымышлен, мы действительно сталкивались с этой проблемой, это было неприятно.

Ошибки¶

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

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

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

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

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

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

// Выброс с ошибкой ReferenceError, потому что z не определен.
try {
    const m = 1;
    const n = m + z;
} catch (err) {
    // Обрабатываем ошибку здесь.
}

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

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

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

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

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    const fs = require('node:fs');
    fs.readFile(
        'файл, который не существует',
        (err, data) => {
            if (err) {
                console.error(
                    'Произошла ошибка при чтении файла!',
                    err
                );
                return;
            }
            // Иначе обрабатываем данные
        }
    );
    
  • Когда асинхронный метод вызывается на объекте, который является EventEmitter, ошибки могут быть направлены в событие 'error' этого объекта.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    const net = require('node:net');
    const connection = net.connect('localhost');
    
    // Добавление обработчика события 'error' к потоку:
    connection.on('error', (err) => {
        // Если соединение сбрасывается сервером, или если не удается
        // соединиться вообще, или при любой ошибке, с которой столкнулось
        // соединением, ошибка будет отправлена сюда.
        console.error(err);
    });
    
    connection.pipe(process.stdout);
    
  • Несколько типично асинхронных методов в API Node.js все еще могут использовать механизм throw для создания исключений, которые должны обрабатываться с помощью try...catch. Полного списка таких методов нет; пожалуйста, обратитесь к документации каждого метода для определения требуемого механизма обработки ошибок.

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

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'));
});

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

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

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fs = require('node:fs');

function errorFirstCallback(err, data) {
    if (err) {
        console.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 внутри обратного вызова error-first:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
// 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);
}

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

Класс: Error

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

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

### new Error(message[, options])

  • сообщение {строка}
  • options {Object}
    • cause {any} Ошибка, которая вызвала вновь созданную ошибку.

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

Error.captureStackTrace(targetObject[, constructorOpt])

  • targetObject {Object}
  • constructorOpt {Функция}

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

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Аналогично `new Error().stack`.

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

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

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

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

// Без передачи MyError в captureStackTrace, MyError
// кадр будет отображаться в свойстве .stack. Передавая
// конструктору, мы опускаем этот кадр и сохраняем все кадры ниже него.
new MyError().stack;

Error.stackTraceLimit

  • {число}

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

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

Если значение не равно числу или равно отрицательному числу, трассировка стека не будет фиксироваться.

error.cause

  • {любая}

Если присутствует, свойство error.cause является основной причиной Error. Оно используется, когда вы ловите ошибку и бросаете новую с другим сообщением или кодом, чтобы сохранить доступ к исходной ошибке.

Свойство error.cause обычно устанавливается вызовом new Error(message, { cause }). Оно не устанавливается конструктором, если не указан параметр cause.

Это свойство позволяет связывать ошибки в цепочку. При сериализации объектов Error, util.inspect() рекурсивно сериализует error.cause, если оно установлено.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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}

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

error.message

  • {string}

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

const err = new Error('Сообщение');
console.error(err.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)

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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, если фрейм представляет собой вызов в пользовательской программе (использующей систему модулей CommonJS), или ее зависимостях.
  • <transport-protocol>:///url/to/module/file.mjs:line:column, если кадр представляет собой вызов в пользовательской программе (с использованием системы модулей ES), или ее зависимостей.

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

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

Класс: AssertionError

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

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

Класс: RangeError

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

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

require('node:net').connect(-1);
// Выбрасывает "RangeError: параметр "port" должен быть >= 0 и < 65536: -1"

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

Класс: ReferenceError

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

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

Хотя клиентский код может генерировать и распространять эти ошибки, на практике это делает только V8.

doesNotExist;
// Выбрасывает ошибку ReferenceError, doesNotExist не является переменной в этой программе.

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

Класс: SyntaxError

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

Указывает, что программа не является валидным JavaScript. Эти ошибки могут генерироваться и распространяться только в результате оценки кода. Оценка кода может происходить в результате eval, Function, require или vm. Эти ошибки почти всегда свидетельствуют о неработающей программе.

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

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

Класс: SystemError

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

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

  • address {строка} Если присутствует, адрес, с которым произошел сбой сетевого соединения.
  • code {string} Строковый код ошибки
  • dest {string} Если присутствует, назначение пути к файлу при сообщении об ошибке файловой системы
  • errno {number} Номер ошибки, предоставляемый системой
  • info {Object} Если присутствует, дополнительные сведения о состоянии ошибки
  • message {string} Предоставленное системой человекочитаемое описание ошибки
  • path {string} Если присутствует, путь к файлу при сообщении об ошибке файловой системы
  • port {number} Если присутствует, порт сетевого подключения, который недоступен
  • syscall {string} Имя системного вызова, вызвавшего ошибку

error.address

  • {строка}

Если присутствует, error.address — это строка, описывающая адрес, с которым не удалось установить сетевое соединение.

error.code

  • {строка}

Свойство error.code — это строка, представляющая код ошибки.

error.dest

  • {строка}

Если присутствует, то error.dest является местом назначения пути к файлу при сообщении об ошибке файловой системы.

error.errno

  • {number}

Свойство error.errno — это отрицательное число, которое соответствует коду ошибки, определенному в libuv Error handling.

В Windows номер ошибки, предоставляемый системой, будет нормализован libuv.

Чтобы получить строковое представление кода ошибки, используйте util.getSystemErrorName(error.errno).

error.info

  • {Object}

Если присутствует, error.info — это объект с подробной информацией о состоянии ошибки.

error.message

  • {string}

error.message — это предоставленное системой человекочитаемое описание ошибки.

error.path

  • {строка}

Если присутствует, error.path — это строка, содержащая соответствующее неверное имя пути.

error.port

  • {число}

Если присутствует, error.port — это порт сетевого подключения, который недоступен.

error.syscall

  • {строка}

Свойство error.syscall — это строка, описывающая syscall, который завершился неудачей.

Общие системные ошибки¶

Это список системных ошибок, часто встречающихся при написании программ на Node.js. Полный список см. на странице errno(3) man page.

  • EACCES (Разрешение отклонено): Была предпринята попытка получить доступ к файлу способом, запрещенным его разрешениями на доступ к файлу.

  • EADDRINUSE (Адрес уже используется): Попытка привязать сервер (net, http или https) к локальному адресу не удалась из-за того, что другой сервер в локальной системе уже занимает этот адрес.

  • ECONNREFUSED (Connection refused): Не удалось установить соединение, поскольку целевая машина активно отказывается от него. Обычно это происходит при попытке подключения к службе, которая неактивна на внешнем узле.

  • ECONNRESET (Connection reset by peer): Соединение было принудительно закрыто сверстником. Обычно это происходит в результате потери соединения на удаленном сокете из-за тайм-аута или перезагрузки. Часто встречается в модулях http и net.

  • EEXIST (Файл существует): Существующий файл был целью операции, которая требовала, чтобы цель не существовала.

  • EISDIR (Is a directory): Операция ожидала файл, но заданный путь оказался каталогом.

  • 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 (Операция завершилась): Запрос на подключение или отправку не прошел, потому что

Класс: TypeError

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

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

require('node:url').parse(() => {});
// Выбросит TypeError, так как ожидается строка.

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

Исключения и ошибки¶

Исключение JavaScript — это значение, которое выбрасывается в результате некорректной операции или как цель оператора throw. Хотя не требуется, чтобы эти значения были экземплярами Error или классами, наследующими от Error, все исключения, выбрасываемые Node.js или временем выполнения JavaScript, будут экземплярами Error.

Некоторые исключения являются неустранимыми на уровне JavaScript. Такие исключения всегда приводят к аварийному завершению процесса Node.js. Примерами могут служить проверки assert() или вызовы abort() на уровне C++.

Ошибки OpenSSL¶

Ошибки, возникающие в crypto или tls, относятся к классу Error, и помимо стандартных свойств .code и .message могут иметь некоторые дополнительные свойства, специфичные для OpenSSL.

error.opensslErrorStack

Массив ошибок, который может дать представление о том, в каком месте библиотеки OpenSSL возникла ошибка.

error.function

Функция OpenSSL, в которой возникла ошибка.

error.library

Библиотека OpenSSL, в которой возникла ошибка.

error.reason

Человекочитаемая строка, описывающая причину ошибки.

Node.js error codes¶

ABORT_ERR

Используется, когда операция была прервана (обычно с помощью AbortController).

API, не использующие AbortSignal, обычно не выдают ошибку с этим кодом.

Этот код не использует обычное соглашение ERR_*, которое используется в ошибках Node.js, чтобы быть совместимым с AbortError веб-платформы.

ERR_ACCESS_DENIED

Специальный тип ошибки, возникающий всякий раз, когда Node.js пытается получить доступ к ресурсу, ограниченному Permission Model.

ERR_AMBIGUOUS_ARGUMENT

Аргумент функции используется таким образом, что подпись функции может быть неправильно понята. Модуль node:assert выбрасывает это сообщение, когда параметр message в assert.throws(block, message) совпадает с сообщением об ошибке, выброшенным block, поскольку такое использование предполагает, что пользователь считает message ожидаемым сообщением, а не сообщением, которое отобразит AssertionError, если block не выбросит сообщение.

ERR_ARG_NOT_ITERABLE

Аргумент iterable (т.е. значение, которое работает с циклами for...of) был необходим, но не предоставлялся API Node.js.

ERR_ASSERTION

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

ERR_ASYNC_CALLBACK

Была предпринята попытка зарегистрировать что-то, что не является функцией, в качестве обратного вызова AsyncHooks.

ERR_ASYNC_TYPE

Тип асинхронного ресурса был неверным. Пользователи также могут определять свои собственные типы при использовании общедоступного API embedder.

ERR_BROTLI_COMPRESSION_FAILED

Данные, переданные в поток Brotli, не были успешно сжаты.

ERR_BROTLI_INVALID_PARAM

При построении потока Brotli был передан недопустимый ключ параметра.

ERR_BUFFER_CONTEXT_NOT_AVAILABLE

Была предпринята попытка создать экземпляр Node.js Buffer из кода аддона или embedder, находясь в JS-движке Context, который не связан с экземпляром Node.js. Данные, переданные в метод Buffer, будут освобождены к моменту возврата метода.

При возникновении этой ошибки возможной альтернативой созданию экземпляра Buffer является создание обычного Uint8Array, который отличается только прототипом получаемого объекта. Uint8Array общеприняты во всех основных API Node.js, где есть Buffer; они доступны во всех Contexts.

ERR_BUFFER_OUT_OF_BOUNDS

Была предпринята попытка выполнить операцию, выходящую за пределы Буфера.

ERR_BUFFER_TOO_LARGE

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

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

В метод getPublicKey() класса crypto.ECDH() было передано недопустимое значение аргумента format.

ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY

В метод crypto.ECDH() класса computeSecret() было передано недопустимое значение аргумента key. Это означает, что открытый ключ лежит за пределами эллиптической кривой.

ERR_CRYPTO_ENGINE_UNKNOWN

В require('node:crypto').setEngine() был передан неверный идентификатор криптографического движка.

ERR_CRYPTO_FIPS_FORCED

Был использован аргумент командной строки --force-fips, но была попытка включить или отключить режим FIPS в модуле node: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

Были предоставлены неверные параметры алгоритма scrypt.

ERR_CRYPTO_INVALID_STATE

Метод crypto был использован на объекте, который находился в недопустимом состоянии. Например, вызов cipher.getAuthTag() перед вызовом cipher.final().

ERR_CRYPTO_INVALID_TAG_LENGTH

Была указана недопустимая длина тега аутентификации.

ERR_CRYPTO_JOB_INIT_FAILED

Инициализация асинхронной криптооперации не удалась.

ERR_CRYPTO_JWK_UNSUPPORTED_CURVE

Эллиптическая кривая ключа не зарегистрирована для использования в JSON Web Key Elliptic Curve Registry.

ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE

Асимметричный тип ключа не зарегистрирован для использования в JSON Web Key Types Registry.

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

Методу 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

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.

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

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.

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.

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

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

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.

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

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.

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.

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.

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

Файл модуля не может быть разрешен загрузчиком модулей CommonJS при попытке выполнить операцию require() или при загрузке точки входа программы.

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.

Used when an HTTP/2 Headers Object is expected.

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

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

Собственный вызов из process.cpuUsage не может быть обработан.

I even tried to achieve the goal using javascript XMLHttpRequest()

var xhttp= new XMLHttpRequest();
try{
  xhttp.onreadystatechange = function() {
    console.log(xhttp);
    if (xhttp.readyState == 4 && xhttp.status == 0) {
      alert("Unknown Error Occured. Server response not received.");
    }
  };
  xhttp.open("POST", "http://localhost:8080/data", true);
  xhttp.send();
}catch(e){
  console.log('catch', e);
}

Above snippet only gives generic error handling, while I am not getting exact reason behind the error. The try...catch statement fails to catch anything, because none of the functions inside try block is throwing any exceptions. It seems XMLHttpRequest is running in background thread, so its runtime error in not being catchable.

As jQuery is a library which is actually a javascript, it will also behave same for $.post() because $.post() is also using XMLHttpRequest behind the curtain.

Below is the jQuery version, which also will handle generic error, as we can not exactly know reason for error.

try {
  $.post('http://localhost:8080/data', {}, function(res) {}).fail(function() {
      alert("Unknown Error Occured. Server response not received.");
  });
} catch (e) {
  console.log('catch', e);
}
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

Conclusion

As javascript XMLHttpRequest() is still not efficient enough for handling different error states, we can not know exact reason behind the network error for AJAX requests. We can only capture generic errors and some other known status codes like

«404» for file not found

«500» for server not responding

More can be known from https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Update:
It has been a very long time since I last updated this post. I saw few answers which try to achieve similar objectives but still with very little success. As mentioned in some of the answers in this thread we can also use XMLHttpRequest.onerror callback function for catching some generic errors but if you are still working with IE, then maybe it won’t work.

Существует ряд причин, по которым код JavaScript может вызывать ошибки, например:

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

Эти типы ошибок известны как ошибки времени выполнения (runtime errors), поскольку они возникают во время выполнения скрипта. Профессиональное приложение должно иметь возможность корректно обрабатывать такие ошибки во время выполнения. Обычно это означает понятное информирование пользователя о возникшей проблеме.

Оператор try…catch

JavaScript предоставляет оператор try-catch, чтобы перехватывать ошибки времени выполнения и корректно их обработать.

Любой код, который может вызвать ошибку, должен быть помещен в блок оператора try, а код для обработки ошибки помещен в блок catch, как показано здесь:

try {
    // Код, который может вызвать ошибку
} catch(error) {
    // Действие, которое нужно выполнить при возникновении ошибки
}

Если ошибка возникает в любой точке блока try, выполнение кода немедленно переносится из блока try в блок catch. Если в блоке try ошибки не возникает, блок catch будет проигнорирован, и программа продолжит выполнение после оператора try-catch.

Следующий пример демонстрирует, как работает оператор try-catch:

try {
    var greet = "Hi, there!";
    document.write(greet);
    
    // Попытка получить доступ к несуществующей переменной
    document.write(welcome);
    
    // Если произошла ошибка, следующая строка не будет выполнена
    alert("All statements are executed successfully.");
} catch(error) {
    // Обработка ошибки
  alert("Caught error: " + error.message);
}
 
// Продолжаем исполнение кода
document.write("<p>Hello World!</p>");

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

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

Оператор try-catch является механизмом обработки исключений. Исключением является сигнал, который указывает, что во время выполнения программы возникли какие-то исключительные условия или ошибки. Термины «исключение» и «ошибка» часто используются взаимозаменяемо.

Оператор try…catch…finally

Оператор try-catch также может содержать предложение finally. Код внутри блока finally всегда будет выполняться независимо от того, произошла ошибка в блоке try или нет.

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

// Присвоение значения, возвращаемого диалоговым окном
var num = prompt("Enter a positive integer between 0 to 100");

// Запоминание времени начала исполнения
var start = Date.now();

try {
    if(num > 0 && num <= 100) {
        alert(Math.pow(num, num)); // the base to the exponent power
    } else {
        throw new Error("An invalid value is entered!");
    }
} catch(e) {
    alert(e.message);
} finally {
    // Отображение времени, необходимого для выполнения кода
    alert("Execution took: " + (Date.now() - start) + "ms");
}

Вызов ошибок с помощью оператора throw

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

Общий синтаксис оператора throw: throw expression;

Выражение expression может быть объектом или значением любого типа данных. Однако лучше использовать объекты, желательно со свойствами name и message. Встроенный в JavaScript конструктор Error() предоставляет удобный способ создания объекта ошибки. Давайте посмотрим на некоторые примеры:

throw 123;
throw "Missing values!";
throw true;
throw { name: "InvalidParameter", message: "Parameter is not a number!" };
throw new Error("Something went wrong!");

Если вы используете встроенные в JavaScript функции конструктора ошибок (например, Error(), TypeError() и т. д.) для создания объектов ошибок, тогда свойство name совпадает с именем конструктора, а message равно аргументу функции конструктора.

Теперь мы собираемся создать функцию squareRoot(), чтобы найти квадратный корень числа. Это можно сделать просто с помощью встроенной в JavaScript функции Math.sqrt(), но проблема здесь в том, что она возвращает NaN для отрицательных чисел, не давая никаких подсказок о том, что пошло не так.

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

function squareRoot(number) {
    // Выдает ошибку, если число отрицательное
    if(number < 0) {
        throw new Error("Sorry, can't calculate square root of a negative number.");
    } else {
        return Math.sqrt(number);
    }
}
    
try {
    squareRoot(16);
    squareRoot(625);
    squareRoot(-9);
    squareRoot(100);
    
    // Если выдается ошибка, следующая строка не будет выполнена
    alert("All calculations are performed successfully.");
} catch(e) {
    // Обработка ошибки
    alert(e.message);
}

Теоретически можно вычислить квадратный корень из отрицательного числа, используя мнимое число i, где i2 = -1. Следовательно, квадратный корень из -4 равен 2i, квадратный корень из -9 равен 3i и так далее. Но мнимые числа не поддерживаются в JavaScript.

Типы ошибок

Объект Error является базовым типом всех ошибок и имеет два основных свойства: name, указывающее тип ошибки и свойство message, которое содержит сообщение, описывающее ошибку более подробно. Любая выданная ошибка будет экземпляром объекта Error.

Существует несколько различных типов ошибок, которые могут возникнуть во время выполнения программы JavaScript, например RangeError, ReferenceError, SyntaxError, TypeError, и URIError.

В следующем разделе описывается каждый из этих типов ошибок более подробно:

RangeError

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

var num = 12.735;
num.toFixed(200); // выдает ошибку диапазона (допустимый диапазон от 0 до 100)

var array = new Array(-1); // выдает ошибку диапазона

ReferenceError

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

var firstName = "Harry";
console.log(firstname); // выдает ошибку ссылки (имена переменных чувствительны к регистру)

undefinedObj.getValues(); // выдает ошибку ссылки

nonexistentArray.length; // выдает ошибку ссылки

SyntaxError

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

var array = ["a", "b", "c"];
document.write(array.slice(2); // выдает синтаксическую ошибку (отсутствует скобка)

alert("Hello World!'); // выдает синтаксическую ошибку (несоответствие кавычек)

TypeError

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

var num = 123;
num.toLowerCase(); /* выдает ошибку (поскольку toLowerCase() является строковым методом, число не может быть преобразовано в нижний регистр) */

var greet = "Hello World!"
greet.join() // выдает ошибку (так как join() является методом массива)

URIError

URIError генерируется, когда вы указали недопустимый URI (расшифровывается как Uniform Resource Identifier) для функций, связанных с URI, таких как encodeURI() или decodeURI(), как показано здесь:

var a = "%E6%A2%B";
decodeURI(a);  // выдает ошибку URI

var b = "uD800";
encodeURI(b);   // выдает ошибку URI

Существует еще один тип ошибки EvalError, который генерируется при возникновении ошибки во время выполнения кода с помощью функции eval(). Хотя эта ошибка больше не генерируется JavaScript, этот объект все еще остается для обратной совместимости.

Конкретный тип ошибки также может быть выдан вручную с использованием соответствующего конструктора и оператора throw. Например, чтобы сгенерировать ошибку TypeError, вы можете использовать конструктор TypeError(), например:

var num = prompt("Please enter a number");

try {
    if(num != "" && num !== null && isFinite(+num)) {
        alert(Math.exp(num));
    } else {
        throw new TypeError("You have not entered a number.");
    }
} catch(e) {
    alert(e.name);
    alert(e.message);
    alert(e.stack); // нестандартное свойство
}

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

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

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

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

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

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

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

try {
  const m = 1;
  const n = m + z;
} catch (err) {
  
}

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

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

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

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

    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;
      }
      
    });
  • Когда асинхронный метод вызывается для объекта, который является EventEmitter , ошибки могут быть перенаправлены на событие 'error' этого объекта .

    const net = require('node:net');
    const connection = net.connect('localhost');
    
    
    connection.on('error', (err) => {
      
      
      
      console.error(err);
    });
    
    connection.pipe(process.stdout);
  • Некоторые обычно асинхронные методы в Node.js API могут по-прежнему использовать механизм throw для создания исключений, которые необходимо обрабатывать с помощью try…catch . Полного списка таких методов не существует; обратитесь к документации каждого метода, чтобы определить необходимый механизм обработки ошибок.

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

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

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

setImmediate(() => {
  
  
  ee.emit('error', new Error('This will crash'));
});

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

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

Error-first callbacks

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

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

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

try {
  fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    
    if (err) {
      throw err;
    }
  });
} catch (err) {
  
  console.error(err);
}

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

Class: Error

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

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

new Error(message[, options])

  • message<string>
  • options<Object>

    • cause <любой> Ошибка, вызвавшая вновь созданную ошибку.

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

Error.captureStackTrace(targetObject[, constructorOpt])

  • targetObject<Object>
  • constructorOpt<Function>

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

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  

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

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

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

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




new MyError().stack;

Error.stackTraceLimit

  • <number>

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

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

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

error.cause

Добавлено в:v16.9.0

  • <any>

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

Свойство error.cause обычно задается вызовом new Error(message, { cause }) . Он не устанавливается конструктором, если параметр cause не указан.

Это свойство позволяет связывать ошибки. При сериализации объектов Error util.inspect() рекурсивно сериализует error.cause , если она установлена.

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);
















error.code

  • <string>

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

error.message

  • <string>

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

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

error.stack

  • <string>

Свойство 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(function speedy() {
    throw new Error('oh no!');
  });
}

makeFaster();














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

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

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

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

Class: AssertionError

  • Extends: <errors.Error>

Указывает на неудачу утверждения. Дополнительные сведения см. В разделе Class: assert.AssertionError .

Class: RangeError

  • Extends: <errors.Error>

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

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

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

Class: ReferenceError

  • Extends: <errors.Error>

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

В то время как клиентский код может генерировать и распространять эти ошибки,на практике это делает только V8.

doesNotExist;

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

Class: SyntaxError

  • Extends: <errors.Error>

Указывает, что программа не является допустимым JavaScript. Эти ошибки могут возникать и распространяться только в результате оценки кода. Оценка кода может происходить в результате eval , Function , require или vm . Эти ошибки почти всегда указывают на неработающую программу.

try {
  require('node:vm').runInThisContext('binary ! isNotOk');
} catch (err) {
  
}

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

Class: SystemError

  • Extends: <errors.Error>

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

  • address <строка> Если присутствует, адрес, к которому не удалось подключиться к сети.
  • code <строка> Код ошибки строки
  • dest <строка> Если присутствует, путь к файлу назначения при сообщении об ошибке файловой системы
  • errno <номер> Номер ошибки, предоставленный системой.
  • info <Object> Если присутствует, дополнительные сведения о состоянии ошибки
  • message <string> Предоставляемое системой описание ошибки в удобной для чтения форме.
  • path <string> Если присутствует, путь к файлу при сообщении об ошибке файловой системы
  • port <номер> Если присутствует, порт сетевого подключения, который недоступен
  • syscall <строка> Имя системного вызова, вызвавшего ошибку.

error.address

  • <string>

Если присутствует, error.address представляет собой строку, описывающую адрес, по которому не удалось установить сетевое соединение.

error.code

  • <string>

Свойство error.code — это строка, представляющая код ошибки.

error.dest

  • <string>

Если присутствует, error.dest — это путь к файлу при сообщении об ошибке файловой системы.

error.errno

  • <number>

Свойство error.errno — это отрицательное число, которое соответствует коду ошибки, определенному в libuv Error handling .

В Windows номер ошибки,предоставляемый системой,будет нормализован libuv.

Чтобы получить строковое представление кода ошибки, используйте util.getSystemErrorName(error.errno) .

error.info

  • <Object>

Если присутствует error.info , это объект с подробной информацией о состоянии ошибки.

error.message

  • <string>

error.message — это предоставляемое системой описание ошибки в удобной для чтения форме.

error.path

  • <string>

Если присутствует, error.path — это строка, содержащая соответствующий недопустимый путь.

error.port

  • <number>

Если присутствует, error.port — это порт сетевого подключения, который недоступен.

error.syscall

  • <string>

Свойство error.syscall — это строка, описывающая сбой системного вызова .

Общие системные ошибки

Это список системных ошибок, которые часто встречаются при написании программы на Node.js. Полный список см. На errno странице errno (3) .

  • EACCES (Permission denied): была предпринята попытка получить доступ к файлу способом, запрещенным его разрешениями на доступ к файлу.

  • 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() не был вызван должным образом.

Class: TypeError

  • Extends <errors.Error>

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

require('node:url').parse(() => { });

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


© Joyent, Inc. and other Node contributors
Licensed under the MIT License.
Node.js is a trademark of Joyent, Inc. and is used with its permission.
We are not endorsed by or affiliated with Joyent.
https://nodejs.org/api/errors.html


Node.js

19.0

  • Domain

  • C++API для встраивания

  • Exceptions vs. errors

  • Legacy Node.js error codes

Понравилась статья? Поделить с друзьями:
  • Javascript обработчик ошибок
  • Javascript вывести ошибку
  • Javascript выбросить ошибку
  • Jaguar ошибка c1165
  • Iwc 5103 коды ошибок