new Console(stdout[, stderr][, ignoreErrors])

new Console(options)

• options <Object>
  • stdout <stream.Writable>
  • stderr <stream.Writable>
  • ignoreErrors <boolean> Игнорировать ошибки при записи в базовые потоки. По умолчанию: true.
  • colorMode <boolean> | <string> Включить или отключить поддержку цвета для этого экземпляра Console. Значение true включает раскрашивание при просмотре значений. Значение false отключает раскрашивание при просмотре значений. Значение 'auto' позволяет определять поддержку цвета по значению свойства isTTY и значению, возвращаемому getColorDepth() для соответствующего потока. Этот параметр нельзя использовать, если также задан inspectOptions.colors. По умолчанию: 'auto'.
  • inspectOptions <Object> | <Map> Задает параметры, передаваемые в util.inspect(). Может быть объектом параметров или, если для stdout и stderr нужны разные параметры, объектом Map, сопоставляющим объекты потоков с параметрами.
  • groupIndentation <number> Задает отступ для групп. По умолчанию: 2.

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

import { createWriteStream } from 'node:fs';
import { Console } from 'node:console';
// Alternatively
// const { Console } = console;

const output = createWriteStream('./stdout.log');
const errorOutput = createWriteStream('./stderr.log');
// Custom simple logger
const logger = new Console({ stdout: output, stderr: errorOutput });
// use it like console
const count = 5;
logger.log('count: %d', count);
// In stdout.log: count 5

const fs = require('node:fs');
const { Console } = require('node:console');
// Alternatively
// const { Console } = console;

const output = fs.createWriteStream('./stdout.log');
const errorOutput = fs.createWriteStream('./stderr.log');
// Custom simple logger
const logger = new Console({ stdout: output, stderr: errorOutput });
// use it like console
const count = 5;
logger.log('count: %d', count);
// In stdout.log: count 5

Глобальный объект console — это специальный объект Console, вывод которого направляется в process.stdout и process.stderr. Он эквивалентен вызову:

new Console({ stdout: process.stdout, stderr: process.stderr }); copy

console.assert(value[, ...message])

• value <any> Значение, проверяемое на истинность.
• ...message <any> Все аргументы, кроме value, используются как сообщение об ошибке.

Если value имеет значение ложного типа или не указан, console.assert() выводит сообщение. Он только выводит сообщение и никак иначе не влияет на выполнение. Вывод всегда начинается с "Assertion failed". Если указан, message форматируется с помощью util.format().

Если value имеет значение истинного типа, ничего не происходит.

console.assert(true, 'does nothing');

console.assert(false, 'Whoops %s work', 'didn\'t');
// Assertion failed: Whoops didn't work

console.assert();
// Assertion failed copy

console.clear()

Если stdout является TTY, вызов console.clear() попытается очистить TTY. Если stdout не является TTY, этот метод ничего не делает.

Конкретное действие console.clear() может различаться в зависимости от операционной системы и типа терминала. В большинстве операционных систем Linux console.clear() работает аналогично команде оболочки clear. В Windows console.clear() очищает только вывод в текущей области просмотра терминала для исполняемого файла Node.js.

console.count([label])

• label <string> Метка счетчика, отображаемая на экране. По умолчанию: 'default'.

Поддерживает внутренний счетчик, связанный с label, и выводит в stdout количество вызовов console.count() с указанным label.

> console.count()
default: 1
undefined
> console.count('default')
default: 2
undefined
> console.count('abc')
abc: 1
undefined
> console.count('xyz')
xyz: 1
undefined
> console.count('abc')
abc: 2
undefined
> console.count()
default: 3
undefined
> copy

console.countReset([label])

• label <string> Метка счетчика, отображаемая на экране. По умолчанию: 'default'.

Сбрасывает внутренний счетчик, связанный с label.

> console.count('abc');
abc: 1
undefined
> console.countReset('abc');
undefined
> console.count('abc');
abc: 1
undefined
> copy

console.debug(data[, ...args])

• data <any>
• ...args <any>

Функция console.debug() является псевдонимом console.log().

console.dir(obj[, options])

• obj <any>
• options <Object>
  • showHidden <boolean> Если true имеет значение true, будут также показаны не перечисляемые свойства объекта и свойства-символы. По умолчанию: false.
  • depth <number> Указывает util.inspect(), сколько раз рекурсивно обходить объект при форматировании. Это полезно для просмотра больших сложных объектов. Чтобы рекурсия была бесконечной, передайте null. По умолчанию: 2.
  • colors <boolean> Если true имеет значение true, вывод будет стилизован с помощью цветовых кодов ANSI. Цвета можно настроить; см. настройку цветов util.inspect(). По умолчанию: false.

Применяет util.inspect() к obj и выводит полученную строку в stdout. Эта функция обходит любую пользовательскую функцию inspect(), определенную для obj.

console.dirxml(...data)

• ...data <any>

Этот метод вызывает console.log() и передает ему полученные аргументы. Метод не создает форматирование XML.

console.error([data][, ...args])

• data <any>
• ...args <any>

Выводит данные в stderr с переводом строки. Можно передать несколько аргументов: первый используется как основное сообщение, а остальные — как значения подстановки, подобно printf(3) (все аргументы передаются в util.format()).

const code = 5;
console.error('error #%d', code);
// Prints: error #5, to stderr
console.error('error', code);
// Prints: error 5, to stderr copy

Если в первой строке не найдены элементы форматирования (например, %d), для каждого аргумента вызывается util.inspect(), а полученные строки объединяются. Дополнительные сведения см. в разделе util.format().

console.group([...label])

• ...label <any>

Увеличивает отступ последующих строк на число пробелов, равное длине groupIndentation.

Если передана одна или несколько строк label, они выводятся первыми без дополнительного отступа.

console.groupCollapsed()

Псевдоним console.group().

console.groupEnd()

Уменьшает отступ последующих строк на число пробелов, равное длине groupIndentation.

console.info([data][, ...args])

• data <any>
• ...args <any>

Функция console.info() является псевдонимом console.log().

console.log([data][, ...args])

• data <any>
• ...args <any>

Выводит данные в stdout с переводом строки. Можно передать несколько аргументов: первый используется как основное сообщение, а остальные — как значения подстановки, подобно printf(3) (все аргументы передаются в util.format()).

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout copy

Дополнительные сведения см. в разделе util.format().

console.table(tabularData[, properties])

• tabularData <any>
• properties <string[]> Альтернативные свойства для создания таблицы.

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

// These can't be parsed as tabular data
console.table(Symbol());
// Symbol()

console.table(undefined);
// undefined

console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]);
// ┌─────────┬─────┬─────┐
// │ (index) │ a   │ b   │
// ├─────────┼─────┼─────┤
// │ 0       │ 1   │ 'Y' │
// │ 1       │ 'Z' │ 2   │
// └─────────┴─────┴─────┘

console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
// ┌─────────┬─────┐
// │ (index) │ a   │
// ├─────────┼─────┤
// │ 0       │ 1   │
// │ 1       │ 'Z' │
// └─────────┴─────┘ copy

console.time([label])

• label <string> По умолчанию: 'default'

Запускает таймер для измерения продолжительности операции. Таймеры идентифицируются по уникальному label. При вызове console.timeEnd() укажите тот же label, чтобы остановить таймер и вывести в stdout прошедшее время в подходящих единицах. Например, если прошло 3869 мс, console.timeEnd() выводит «3.869s».

console.timeEnd([label])

• label <string> По умолчанию: 'default'

Останавливает таймер, ранее запущенный вызовом console.time(), и выводит результат в stdout:

console.time('bunch-of-stuff');
// Do a bunch of stuff.
console.timeEnd('bunch-of-stuff');
// Prints: bunch-of-stuff: 225.438ms copy

console.timeLog([label][, ...data])

• label <string> По умолчанию: 'default'
• ...data <any>

Для таймера, ранее запущенного вызовом console.time(), выводит прошедшее время и другие аргументы data в stdout:

console.time('process');
const value = expensiveProcess1(); // Returns 42
console.timeLog('process', value);
// Prints "process: 365.227ms 42".
doExpensiveProcess2(value);
console.timeEnd('process'); copy

console.trace([message][, ...args])

• message <any>
• ...args <any>

Выводит в stderr строку 'Trace: ', за которой следуют форматированное сообщение, созданное с помощью util.format(), и трассировка стека до текущей позиции в коде.

console.trace('Show me');
// Prints: (stack trace will vary based on where trace is called)
//  Trace: Show me
//    at repl:2:9
//    at REPLServer.defaultEval (repl.js:248:27)
//    at bound (domain.js:287:14)
//    at REPLServer.runBound [as eval] (domain.js:300:12)
//    at REPLServer.<anonymous> (repl.js:412:12)
//    at emitOne (events.js:82:20)
//    at REPLServer.emit (events.js:169:7)
//    at REPLServer.Interface._onLine (readline.js:210:10)
//    at REPLServer.Interface._line (readline.js:549:8)
//    at REPLServer.Interface._ttyWrite (readline.js:826:14) copy

console.warn([data][, ...args])

• data <any>
• ...args <any>

Функция console.warn() является псевдонимом console.error().

console.profile([label])

• label <string>

Этот метод ничего не отображает, если не используется в инспекторе. Метод console.profile() запускает профилирование процессора JavaScript с необязательной меткой и выполняется до вызова console.profileEnd(). Затем профиль добавляется на панель Profile инспектора.

console.profile('MyLabel');
// Some code
console.profileEnd('MyLabel');
// Adds the profile 'MyLabel' to the Profiles panel of the inspector. copy

console.profileEnd([label])

• label <string>

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

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

console.timeStamp([label])

• label <string>

Этот метод ничего не отображает, если не используется в инспекторе. Метод console.timeStamp() добавляет событие с меткой 'label' на панель Timeline инспектора.