Node js вывод ошибок - Не ошибается лишь тот, кто ничего не делает!

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

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

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

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

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

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

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

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

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

Исключения

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

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

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

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

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

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

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

function (err, result) {}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Типы ошибок

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Принять TypeScript

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        function doAthing() {
    byDoingSomethingElse();
}

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

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

init();

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

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

Стек вызовов

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

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

function changeDataFormat() {
    // ...
}

function storeData(){
    // ...
}

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

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

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

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

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

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

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

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

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

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

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

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

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

***

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

Заключение

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

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

***

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

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

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return num * num;
}

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

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

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

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

function (err, result) {}

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

const fs = require('fs');

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

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

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

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

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

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

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

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

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

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

  console.log(result);
});

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return emitter;
}

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

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

const counter = emitCount();

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

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

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

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

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

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

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

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

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

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

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

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

  return input;
}

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

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

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

Типы ошибок

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. Примите TypeScript

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Резюме

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

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

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

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

Вывод

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

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

Источник

Ошибки¶

Приложения, работающие на 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, то произошла ошибка, которую следует обработать.

const fs = require('node:fs');
fs.readFile(
    'файл, который не существует',
    (err, data) => {
        if (err) {
            console.error(
                'Произошла ошибка при чтении файла!',
                err
            );
            return;
        }
        // Иначе обрабатываем данные
    }
);

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

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.

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:

// 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, если оно установлено.

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, не будет присутствовать в стековых трассах:

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 have a simple example:

var str = '{ "test"  : 1, }'

try {
    JSON.parse(str);
} catch (e) {
    console.log(e)
}

result:

[SyntaxError: Unexpected token }]

How to print all error info ?

Expected result:

undefined:1
{ "test"  : 1, }
         ^
SyntaxError: Unexpected token }

asked Jan 11, 2013 at 10:05

This will help:

var x = { asd: "asd", };

try {
    JSON.parse(x);
}
catch (e) {
    console.log("Error", e.stack);
    console.log("Error", e.name);
    console.log("Error", e.message);
}

error.stack is not exactly what you want, but it will help you.

answered Jan 11, 2013 at 12:39

randunelrandunel

8,8981 gold badge25 silver badges24 bronze badges

This will show you the various ways in which you can get the info available:

var str = '{"test": 1, }';

try {
    JSON.parse(str);
} catch(e) {

    console.log("error object:");
    console.log(e);
    console.log();

    console.log("error object toString():");
    console.log("t" + e.toString());

    console.log();
    console.log("error object attributes: ");
    console.log('tname: ' + e.name + ' message: ' + e.message + ' at: ' + e.at + ' text: ' + e.text);

    console.log();
    console.log("error object stack: ");
    console.log(e.stack);
}

The output is:

error object:
[SyntaxError: Unexpected token }]

error object toString():
    SyntaxError: Unexpected token }

error object attributes: 
    name: SyntaxError message: Unexpected token } at: undefined text: undefined

error object stack: 
SyntaxError: Unexpected token }
    at Object.parse (native)
    at Object.<anonymous> (/home/james/devel/tests/node/test.js:4:10)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Module.runMain (module.js:492:10)
    at process.startup.processNextTick.process._tickCallback (node.js:244:9)

You can take your pick

Asaph

158k25 gold badges193 silver badges198 bronze badges

answered Jan 11, 2013 at 12:43

MetalskinMetalskin

3,9885 gold badges37 silver badges61 bronze badges

Источник

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

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

Исключения

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

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

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

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

Типы ошибок

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

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

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

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

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

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

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

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

Принять TypeScript

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

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

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

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

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

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

Стек вызовов

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

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

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

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

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

Заключение

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

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

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

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

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

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

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

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

Типы ошибок

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

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

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

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

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

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

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

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

1. Примите TypeScript

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

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

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

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

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

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

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

Резюме

Вывод

Ошибки¶

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

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

Класс: Error¶

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

Error.captureStackTrace(targetObject[, constructorOpt])¶

Error.stackTraceLimit¶

error.cause¶

error.code¶

error.message¶

error.stack¶

Класс: AssertionError¶

Класс: RangeError¶

Класс: ReferenceError¶

Класс: SyntaxError¶

Класс: SystemError¶

error.address¶

error.code¶

error.dest¶

error.errno¶

error.info¶

error.message¶

error.path¶

Класс: `Error`¶

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

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

`Error.stackTraceLimit`¶

`error.cause`¶

`error.code`¶

`error.message`¶

`error.stack`¶

Класс: `AssertionError`¶

Класс: `RangeError`¶

Класс: `ReferenceError`¶

Класс: `SyntaxError`¶

Класс: `SystemError`¶

`error.address`¶

`error.code`¶

`error.dest`¶

`error.errno`¶

`error.info`¶

`error.message`¶

`error.path`¶

`error.port`¶

`error.syscall`¶

Класс: `TypeError`¶

`error.opensslErrorStack`¶

`error.function`¶

`error.library`¶

`error.reason`¶

`ABORT_ERR`¶

`ERR_ACCESS_DENIED`¶

`ERR_AMBIGUOUS_ARGUMENT`¶

`ERR_ARG_NOT_ITERABLE`¶

`ERR_ASSERTION`¶

`ERR_ASYNC_CALLBACK`¶

`ERR_ASYNC_TYPE`¶

`ERR_BROTLI_COMPRESSION_FAILED`¶

`ERR_BROTLI_INVALID_PARAM`¶

`ERR_BUFFER_CONTEXT_NOT_AVAILABLE`¶

`ERR_BUFFER_OUT_OF_BOUNDS`¶

`ERR_BUFFER_TOO_LARGE`¶

`ERR_CANNOT_WATCH_SIGINT`¶

`ERR_CHILD_CLOSED_BEFORE_REPLY`¶

`ERR_CHILD_PROCESS_IPC_REQUIRED`¶

`ERR_CHILD_PROCESS_STDIO_MAXBUFFER`¶

`ERR_CLOSED_MESSAGE_PORT`¶

`ERR_CONSOLE_WRITABLE_STREAM`¶

`ERR_CONSTRUCT_CALL_INVALID`¶

`ERR_CONSTRUCT_CALL_REQUIRED`¶

`ERR_CONTEXT_NOT_INITIALIZED`¶

`ERR_CRYPTO_CUSTOM_ENGINE_NOT_SUPPORTED`¶

`ERR_CRYPTO_ECDH_INVALID_FORMAT`¶

`ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY`¶

`ERR_CRYPTO_ENGINE_UNKNOWN`¶

`ERR_CRYPTO_FIPS_FORCED`¶

`ERR_CRYPTO_FIPS_UNAVAILABLE`¶

`ERR_CRYPTO_HASH_FINALIZED`¶

`ERR_CRYPTO_HASH_UPDATE_FAILED`¶

`ERR_CRYPTO_INCOMPATIBLE_KEY`¶

`ERR_CRYPTO_INCOMPATIBLE_KEY_OPTIONS`¶

`ERR_CRYPTO_INITIALIZATION_FAILED`¶

`ERR_CRYPTO_INVALID_AUTH_TAG`¶

`ERR_CRYPTO_INVALID_COUNTER`¶

`ERR_CRYPTO_INVALID_CURVE`¶

`ERR_CRYPTO_INVALID_DIGEST`¶

`ERR_CRYPTO_INVALID_IV`¶

`ERR_CRYPTO_INVALID_JWK`¶

`ERR_CRYPTO_INVALID_KEY_OBJECT_TYPE`¶

`ERR_CRYPTO_INVALID_KEYLEN`¶

`ERR_CRYPTO_INVALID_KEYPAIR`¶

`ERR_CRYPTO_INVALID_KEYTYPE`¶

`ERR_CRYPTO_INVALID_MESSAGELEN`¶

`ERR_CRYPTO_INVALID_SCRYPT_PARAMS`¶

`ERR_CRYPTO_INVALID_STATE`¶

`ERR_CRYPTO_INVALID_TAG_LENGTH`¶

`ERR_CRYPTO_JOB_INIT_FAILED`¶

`ERR_CRYPTO_JWK_UNSUPPORTED_CURVE`¶

`ERR_CRYPTO_JWK_UNSUPPORTED_KEY_TYPE`¶

`ERR_CRYPTO_OPERATION_FAILED`¶

`ERR_CRYPTO_PBKDF2_ERROR`¶

`ERR_CRYPTO_SCRYPT_INVALID_PARAMETER`¶

`ERR_CRYPTO_SCRYPT_NOT_SUPPORTED`.¶