Console API リファレンス

Kayce Basques 氏
Kayce Basques
ソフィア・エメリアノバ
Sofia Emelianova

Console API を使用して、JavaScript からコンソールにメッセージを書き込みます。このトピックに関するインタラクティブな概要については、コンソールへのメッセージのロギングを開始するをご覧ください。

コンソールでのみ使用可能な debug(function)monitorEvents(node) などの便利なメソッドについては、コンソール ユーティリティ API リファレンスをご覧ください。

console.assert(式, オブジェクト)

ログレベル: Error

expressionfalse と評価されると、コンソールにエラーを書き込みます。

const x = 5;
const y = 3;
const reason = 'x is expected to be less than y';
console.assert(x < y, {x, y, reason});

上記の console.assert() の例の結果。

console.clear()

コンソールをクリアします。

console.clear();

[ログを保持] が有効になっている場合、console.clear() は無効になります。

または、ALT_TEXT_HERE アイコンをクリックしてコンソールをクリアすることもできます。

console.count([label])

ログレベル: Info

同じ行で同じ labelcount() が呼び出された回数を書き込みます。console.countReset([label]) を呼び出してカウントをリセットします。

console.count();
console.count('coffee');
console.count();
console.count();

上の console.count() の例の結果。

console.countReset([label])

カウントをリセットします。

console.countReset();
console.countReset('coffee');

console.createTask(name)

現在のスタック トレースを、作成された task オブジェクトに関連付ける Task インスタンスを返します。後でこの task オブジェクトを使用して、関数(次の例では f)を実行できます。task.run(f) は任意のペイロードを実行し、戻り値を呼び出し元に転送します。

// Task creation
const task = console.createTask(name);

// Task execution
task.run(f); // instead of f();

task は、async 関数の作成コンテキストとコンテキストをリンクします。このリンクにより、DevTools で非同期処理のスタック トレースが改善されます。詳細については、リンクされたスタック トレースをご覧ください。

console.debug(object [, object, ...])

ログレベル: Verbose

ログレベルが異なる以外は console.log(object [, object, ...]) と同じです。

console.debug('debug');

上記の console.debug() の例の結果。

console.dir(object)

ログレベル: Info

指定されたオブジェクトの JSON 表現を出力します。

console.dir(document.head);

上記の console.dir() の例の結果。

console.dirxml(node)

ログレベル: Info

node の子孫の XML 表現を出力します。

console.dirxml(document);

上記の console.dirxml() の例の結果。

console.error(object [, object, ...])

ログレベル: Error

object をコンソールに出力し、エラーとしてフォーマットして、スタック トレースを含めます。

console.error("I'm sorry, Dave. I'm afraid I can't do that.");

上記の console.error() の例の結果。

console.group(label)

console.groupEnd(label) が呼び出されるまで、メッセージを視覚的にグループ化します。console.groupCollapsed(label) を使用して、最初にコンソールに記録されたときにグループを閉じます。

const label = 'Adolescent Irradiated Espionage Tortoises';
console.group(label);
console.info('Leo');
console.info('Mike');
console.info('Don');
console.info('Raph');
console.groupEnd(label);

上の console.group() の例の結果。

また、グループをネストすることもできます。

const timeline1 = 'New York 2012';
const timeline2 = 'Camp Lehigh 1970';
console.group(timeline1);
console.info('Mind');
console.info('Time');
console.group(timeline2);
console.info('Space');
console.info('Extra Pym Particles');
console.groupEnd(timeline2);
console.groupEnd(timeline1);

ネストされたグループ。

console.groupCollapsed(label)

console.group(label) と同じですが、コンソールにログが記録された時点で、グループが最初に閉じられる点が異なります。

console.groupEnd(label)

メッセージの視覚的なグループ化を停止します。詳細については、console.group をご覧ください。

console.info(object [, object, ...])

ログレベル: Info

console.log(object [, object, ...]) と同じです。

console.info('info');

上の console.info() の例の結果。

console.log(object [, object, ...])

ログレベル: Info

コンソールにメッセージを出力します。

console.log('log');

上の console.log() の例の結果。

console.table(配列 [, 列])

ログレベル: Info

オブジェクトの配列をテーブルとしてログに記録します。

var people = [
  {
    first: 'René',
    last: 'Magritte',
  },
  {
    first: 'Chaim',
    last: 'Soutine',
    birthday: '18930113',
  },
  {
    first: 'Henri',
    last: 'Matisse',
  }
];
console.table(people);

上の console.table() の例の結果。

デフォルトでは、console.table() はすべてのテーブルデータをログに記録します。単一の列または列のサブセットを表示するには、2 番目のオプションのパラメータを使用し、列名または列名を文字列または文字列の配列として指定します。次に例を示します。

console.table(people, ['last', 'birthday']);

console.table() でログに記録されたテーブル内の列のサブセット。

console.time([label])

新しいタイマーを開始します。console.timeEnd([label]) を呼び出してタイマーを停止し、経過時間をコンソールに出力します。

console.time();
for (var i = 0; i < 100000; i++) {
  let square = i ** 2;
}
console.timeEnd();

上の console.time() の例の結果。

console.timeEnd([label])

ログレベル: Info

タイマーを停止します。詳細については、console.time() をご覧ください。

console.trace()

ログレベル: Info

スタック トレースをコンソールに出力します。

const first = () => { second(); };
const second = () => { third(); };
const third = () => { fourth(); };
const fourth = () => { console.trace(); };
first();

上記の console.trace() の例の結果。

console.warn(object [, object, ...])

ログレベル: Warning

コンソールに警告を出力します。

console.warn('warn');

上の console.warn() の例の結果。