Node.js v21.7.2 文件

類別：Console#

Console 類別可用於建立一個具有可設定輸出串流的簡單記錄器，並且可以使用 require('node:console').Console 或 console.Console（或其解構對應項）存取

const { Console } = require('node:console'); copy

const { Console } = console; copy

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

new Console(options)#

• options <物件>
  • stdout <stream.Writable>
  • stderr <stream.Writable>
  • ignoreErrors <布林> 寫入基礎串流時忽略錯誤。預設： true。
  • colorMode <布林> | <字串> 設定此 Console 執行個體的色彩支援。設定為 true 會在檢查值時啟用色彩。設定為 false 會在檢查值時停用色彩。設定為 'auto' 會使色彩支援依賴於 isTTY 屬性的值和各自串流上 getColorDepth() 傳回的值。如果同時設定了 inspectOptions.colors，則無法使用此選項。預設： 'auto'。
  • inspectOptions <Object> 指定傳遞給 util.inspect() 的選項。
  • groupIndentation <number> 設定群組縮排。預設值：2。

使用一個或兩個可寫入串流實例建立新的 Console。stdout 是可寫入串流，用於列印記錄或資訊輸出。stderr 用於警告或錯誤輸出。如果未提供 stderr，則 stdout 會用於 stderr。

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 copy

全域 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 shell 指令。在 Windows 上，console.clear() 將只清除 Node.js 二進位檔的目前終端機視窗中的輸出。

console.count([label])#

• label <字串> 計數器的顯示標籤。預設值：'default'。

維護特定於 label 的內部計數器，並將 console.count() 已使用指定 label 呼叫的次數輸出至 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 <字串> 計數器的顯示標籤。預設值：'default'。

重設特定於 label 的內部計數器。

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

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

• data <任何>
• ...args <任何>

console.debug() 函式為 console.log() 的別名。

console.dir(obj[, options])#

• obj <任何>
• options <物件>
  • showHidden <布林> 如果為 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 <任何>
• ...args <任何>

列印到 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([...標籤])#

• ...標籤 <any>

將後續行縮排增加 groupIndentation 長度的空格。

如果提供一個或多個 標籤，這些標籤會先列印，而不會額外縮排。

console.groupCollapsed()#

console.group() 的別名。

console.groupEnd()#

將後續行縮排減少 groupIndentation 長度的空格。

console.info([資料][, ...引數])#

• data <任何>
• ...args <任何>

console.info() 函式是 console.log() 的別名。

console.log([資料][, ...引數])#

• data <任何>
• ...args <任何>

列印到 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。例如，如果經過時間為 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([訊息][, ...引數])#

• 訊息 <任何>
• ...args <任何>

列印字串 'Trace: ' 到 stderr，接著是 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 <任何>

console.warn() 函式是 console.error() 的別名。

僅限檢查器的方法#

下列方法由 V8 引擎公開在一般 API 中，但除非與 檢查器 (--inspect 旗標) 一起使用，否則不會顯示任何內容。

console.profile([標籤])#

• 標籤 <字串>

除非在檢查器中使用，否則此方法不會顯示任何內容。console.profile() 方法會啟動一個 JavaScript CPU 設定檔，並附帶一個選用標籤，直到 console.profileEnd() 被呼叫。然後，設定檔會加入檢查器的 設定檔 面板。

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

console.profileEnd([標籤])#

• 標籤 <字串>

此方法不會顯示任何內容，除非在檢查器中使用。如果已開始，則停止目前的 JavaScript CPU 分析記錄，並將報告列印至檢查器的分析記錄面板。請參閱 console.profile() 以取得範例。

如果未標籤呼叫此方法，則會停止最近開始的分析記錄。

console.timeStamp([label])#

• 標籤 <字串>

此方法不會顯示任何內容，除非在檢查器中使用。console.timeStamp() 方法會將標籤為 'label' 的事件新增至檢查器的時間軸面板。