Node.js v25.0.0 ドキュメンテーション

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。

1つまたは2つの書き込み可能なストリームインスタンスを持つ新しい Console を作成します。stdout はログや情報出力を表示するための書き込み可能なストリームです。stderr は警告やエラー出力に使用されます。stderr が提供されない場合、stdout が stderr にも使用されます。

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 5const 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 5copy

グローバルな console は、出力が process.stdout と process.stderr に送信される特別な Console です。これは以下を呼び出すことと同等です。

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

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

• value <any> truthy であるかをテストされる値。
• ...message <any> value 以外のすべての引数はエラーメッセージとして使用されます。

console.assert() は、value が falsy であるか、または省略された場合にメッセージを書き込みます。メッセージを書き込むだけで、それ以外の実行には影響を与えません。出力は常に "Assertion failed" で始まります。message が提供された場合、util.format() を使用してフォーマットされます。

value が truthy の場合、何も起こりません。

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 に固有の内部カウンターを維持し、与えられた label で console.count() が呼び出された回数を stdout に出力します。

> 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 の場合、オブジェクトの列挙不可能なプロパティとシンボルプロパティも表示されます。デフォルト: false。
  • depth <number> オブジェクトをフォーマットする際に util.inspect() が再帰する回数を指定します。これは、大きくて複雑なオブジェクトをインスペクトするのに役立ちます。無制限に再帰させるには null を渡します。デフォルト: 2。
  • colors <boolean> true の場合、出力は ANSI カラーコードでスタイル付けされます。色はカスタマイズ可能です。util.inspect() の色のカスタマイズを参照してください。デフォルト: false。

obj に対して util.inspect() を使用し、結果の文字列を stdout に出力します。この関数は、obj に定義されたカスタムの inspect() 関数をバイパスします。

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 の長さ分のスペースで増やします。

1つ以上の 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 で識別されます。タイマーを停止し、経過時間を適切な時間単位で stdout に出力するには、console.timeEnd() を呼び出すときに同じ label を使用します。たとえば、経過時間が 3869ms の場合、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() メソッドは、console.profileEnd() が呼び出されるまで、オプションのラベル付きで JavaScript CPU プロファイルを開始します。その後、プロファイルはインスペクターの 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 CPU プロファイリングセッションを停止し、レポートをインスペクターの Profiles パネルに出力します。例については console.profile() を参照してください。

このメソッドがラベルなしで呼び出された場合、最も最近開始されたプロファイルが停止されます。

console.timeStamp([label])#

• label <string>

このメソッドはインスペクターで使用しない限り何も表示しません。console.timeStamp() メソッドは、ラベル 'label' のイベントをインスペクターの Timeline パネルに追加します。