• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <meta charset="utf-8">
5  <meta name="viewport" content="width=device-width">
6  <meta name="nodejs.org:node-version" content="v14.19.1">
7  <title>Console | Node.js v14.19.1 Documentation</title>
8  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
9  <link rel="stylesheet" href="assets/style.css">
10  <link rel="stylesheet" href="assets/hljs.css">
11  <link rel="canonical" href="https://nodejs.org/api/console.html">
12</head>
13<body class="alt apidoc" id="api-section-console">
14  <div id="content" class="clearfix">
15    <div id="column2" class="interior">
16      <div id="intro" class="interior">
17        <a href="/" title="Go back to the home page">
18          Node.js
19        </a>
20      </div>
21      <ul>
22<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li>
23<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li>
24</ul>
25<hr class="line">
26<ul>
27<li><a href="assert.html" class="nav-assert">Assertion testing</a></li>
28<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li>
29<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
30<li><a href="addons.html" class="nav-addons">C++ addons</a></li>
31<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li>
32<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li>
33<li><a href="child_process.html" class="nav-child_process">Child processes</a></li>
34<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
35<li><a href="cli.html" class="nav-cli">Command-line options</a></li>
36<li><a href="console.html" class="nav-console active">Console</a></li>
37<li><a href="corepack.html" class="nav-corepack">Corepack</a></li>
38<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
39<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
40<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
41<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li>
42<li><a href="dns.html" class="nav-dns">DNS</a></li>
43<li><a href="domain.html" class="nav-domain">Domain</a></li>
44<li><a href="errors.html" class="nav-errors">Errors</a></li>
45<li><a href="events.html" class="nav-events">Events</a></li>
46<li><a href="fs.html" class="nav-fs">File system</a></li>
47<li><a href="globals.html" class="nav-globals">Globals</a></li>
48<li><a href="http.html" class="nav-http">HTTP</a></li>
49<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
50<li><a href="https.html" class="nav-https">HTTPS</a></li>
51<li><a href="inspector.html" class="nav-inspector">Inspector</a></li>
52<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
53<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li>
54<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li>
55<li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li>
56<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li>
57<li><a href="net.html" class="nav-net">Net</a></li>
58<li><a href="os.html" class="nav-os">OS</a></li>
59<li><a href="path.html" class="nav-path">Path</a></li>
60<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li>
61<li><a href="policy.html" class="nav-policy">Policies</a></li>
62<li><a href="process.html" class="nav-process">Process</a></li>
63<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
64<li><a href="querystring.html" class="nav-querystring">Query strings</a></li>
65<li><a href="readline.html" class="nav-readline">Readline</a></li>
66<li><a href="repl.html" class="nav-repl">REPL</a></li>
67<li><a href="report.html" class="nav-report">Report</a></li>
68<li><a href="stream.html" class="nav-stream">Stream</a></li>
69<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li>
70<li><a href="timers.html" class="nav-timers">Timers</a></li>
71<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
72<li><a href="tracing.html" class="nav-tracing">Trace events</a></li>
73<li><a href="tty.html" class="nav-tty">TTY</a></li>
74<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li>
75<li><a href="url.html" class="nav-url">URL</a></li>
76<li><a href="util.html" class="nav-util">Utilities</a></li>
77<li><a href="v8.html" class="nav-v8">V8</a></li>
78<li><a href="vm.html" class="nav-vm">VM</a></li>
79<li><a href="wasi.html" class="nav-wasi">WASI</a></li>
80<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li>
81<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
82</ul>
83<hr class="line">
84<ul>
85<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li>
86</ul>
87    </div>
88
89    <div id="column1" data-id="console" class="interior">
90      <header>
91        <div class="header-container">
92          <h1>Node.js v14.19.1 documentation</h1>
93          <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden>
94            <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24">
95              <path fill="none" d="M0 0h24v24H0z" />
96              <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/>
97              <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/>
98            </svg>
99            <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24">
100              <path d="M0 0h24v24H0z" fill="none" />
101              <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/>
102            </svg>
103          </button>
104        </div>
105        <div id="gtoc">
106          <ul>
107            <li>
108              <a href="index.html">Index</a>
109            </li>
110            <li>
111              <a href="all.html">View on single page</a>
112            </li>
113            <li>
114              <a href="console.json">View as JSON</a>
115            </li>
116
117    <li class="version-picker">
118      <a href="#">View another version <span>&#x25bc;</span></a>
119      <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v17.x/api/console.html">17.x</a></li>
120<li><a href="https://nodejs.org/docs/latest-v16.x/api/console.html">16.x <b>LTS</b></a></li>
121<li><a href="https://nodejs.org/docs/latest-v15.x/api/console.html">15.x</a></li>
122<li><a href="https://nodejs.org/docs/latest-v14.x/api/console.html">14.x <b>LTS</b></a></li>
123<li><a href="https://nodejs.org/docs/latest-v13.x/api/console.html">13.x</a></li>
124<li><a href="https://nodejs.org/docs/latest-v12.x/api/console.html">12.x <b>LTS</b></a></li>
125<li><a href="https://nodejs.org/docs/latest-v11.x/api/console.html">11.x</a></li>
126<li><a href="https://nodejs.org/docs/latest-v10.x/api/console.html">10.x</a></li>
127<li><a href="https://nodejs.org/docs/latest-v9.x/api/console.html">9.x</a></li>
128<li><a href="https://nodejs.org/docs/latest-v8.x/api/console.html">8.x</a></li>
129<li><a href="https://nodejs.org/docs/latest-v7.x/api/console.html">7.x</a></li>
130<li><a href="https://nodejs.org/docs/latest-v6.x/api/console.html">6.x</a></li>
131<li><a href="https://nodejs.org/docs/latest-v5.x/api/console.html">5.x</a></li>
132<li><a href="https://nodejs.org/docs/latest-v4.x/api/console.html">4.x</a></li>
133<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/console.html">0.12.x</a></li>
134<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/console.html">0.10.x</a></li></ol>
135    </li>
136
137            <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/console.md">Edit on GitHub</a></li>
138          </ul>
139        </div>
140        <hr>
141      </header>
142
143      <details id="toc" open><summary>Table of contents</summary><ul>
144<li><span class="stability_2"><a href="#console_console">Console</a></span>
145<ul>
146<li><a href="#console_class_console">Class: <code>Console</code></a>
147<ul>
148<li><a href="#console_new_console_stdout_stderr_ignoreerrors"><code>new Console(stdout[, stderr][, ignoreErrors])</code></a></li>
149<li><a href="#console_new_console_options"><code>new Console(options)</code></a></li>
150<li><a href="#console_console_assert_value_message"><code>console.assert(value[, ...message])</code></a></li>
151<li><a href="#console_console_clear"><code>console.clear()</code></a></li>
152<li><a href="#console_console_count_label"><code>console.count([label])</code></a></li>
153<li><a href="#console_console_countreset_label"><code>console.countReset([label])</code></a></li>
154<li><a href="#console_console_debug_data_args"><code>console.debug(data[, ...args])</code></a></li>
155<li><a href="#console_console_dir_obj_options"><code>console.dir(obj[, options])</code></a></li>
156<li><a href="#console_console_dirxml_data"><code>console.dirxml(...data)</code></a></li>
157<li><a href="#console_console_error_data_args"><code>console.error([data][, ...args])</code></a></li>
158<li><a href="#console_console_group_label"><code>console.group([...label])</code></a></li>
159<li><a href="#console_console_groupcollapsed"><code>console.groupCollapsed()</code></a></li>
160<li><a href="#console_console_groupend"><code>console.groupEnd()</code></a></li>
161<li><a href="#console_console_info_data_args"><code>console.info([data][, ...args])</code></a></li>
162<li><a href="#console_console_log_data_args"><code>console.log([data][, ...args])</code></a></li>
163<li><a href="#console_console_table_tabulardata_properties"><code>console.table(tabularData[, properties])</code></a></li>
164<li><a href="#console_console_time_label"><code>console.time([label])</code></a></li>
165<li><a href="#console_console_timeend_label"><code>console.timeEnd([label])</code></a></li>
166<li><a href="#console_console_timelog_label_data"><code>console.timeLog([label][, ...data])</code></a></li>
167<li><a href="#console_console_trace_message_args"><code>console.trace([message][, ...args])</code></a></li>
168<li><a href="#console_console_warn_data_args"><code>console.warn([data][, ...args])</code></a></li>
169</ul>
170</li>
171<li><a href="#console_inspector_only_methods">Inspector only methods</a>
172<ul>
173<li><a href="#console_console_profile_label"><code>console.profile([label])</code></a></li>
174<li><a href="#console_console_profileend_label"><code>console.profileEnd([label])</code></a></li>
175<li><a href="#console_console_timestamp_label"><code>console.timeStamp([label])</code></a></li>
176</ul>
177</li>
178</ul>
179</li>
180</ul></details>
181
182      <div id="apicontent">
183        <h2>Console<span><a class="mark" href="#console_console" id="console_console">#</a></span></h2>
184
185<p></p><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">Stability: 2</a> - Stable</div><p></p>
186<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v14.19.1/lib/console.js">lib/console.js</a></p>
187<p>The <code>console</code> module provides a simple debugging console that is similar to the
188JavaScript console mechanism provided by web browsers.</p>
189<p>The module exports two specific components:</p>
190<ul>
191<li>A <code>Console</code> class with methods such as <code>console.log()</code>, <code>console.error()</code> and
192<code>console.warn()</code> that can be used to write to any Node.js stream.</li>
193<li>A global <code>console</code> instance configured to write to <a href="process.html#process_process_stdout"><code>process.stdout</code></a> and
194<a href="process.html#process_process_stderr"><code>process.stderr</code></a>. The global <code>console</code> can be used without calling
195<code>require('console')</code>.</li>
196</ul>
197<p><em><strong>Warning</strong></em>: The global console object's methods are neither consistently
198synchronous like the browser APIs they resemble, nor are they consistently
199asynchronous like all other Node.js streams. See the <a href="process.html#process_a_note_on_process_i_o">note on process I/O</a> for
200more information.</p>
201<p>Example using the global <code>console</code>:</p>
202<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'hello world'</span>);
203<span class="hljs-comment">// Prints: hello world, to stdout</span>
204<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'hello %s'</span>, <span class="hljs-string">'world'</span>);
205<span class="hljs-comment">// Prints: hello world, to stdout</span>
206<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(<span class="hljs-string">'Whoops, something bad happened'</span>));
207<span class="hljs-comment">// Prints error message and stack trace to stderr:</span>
208<span class="hljs-comment">//   Error: Whoops, something bad happened</span>
209<span class="hljs-comment">//     at [eval]:5:15</span>
210<span class="hljs-comment">//     at Script.runInThisContext (node:vm:132:18)</span>
211<span class="hljs-comment">//     at Object.runInThisContext (node:vm:309:38)</span>
212<span class="hljs-comment">//     at node:internal/process/execution:77:19</span>
213<span class="hljs-comment">//     at [eval]-wrapper:6:22</span>
214<span class="hljs-comment">//     at evalScript (node:internal/process/execution:76:60)</span>
215<span class="hljs-comment">//     at node:internal/main/eval_string:23:3</span>
216
217<span class="hljs-keyword">const</span> name = <span class="hljs-string">'Will Robinson'</span>;
218<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">warn</span>(<span class="hljs-string">`Danger <span class="hljs-subst">${name}</span>! Danger!`</span>);
219<span class="hljs-comment">// Prints: Danger Will Robinson! Danger!, to stderr</span></code></pre>
220<p>Example using the <code>Console</code> class:</p>
221<pre><code class="language-js"><span class="hljs-keyword">const</span> out = <span class="hljs-title function_">getStreamSomehow</span>();
222<span class="hljs-keyword">const</span> err = <span class="hljs-title function_">getStreamSomehow</span>();
223<span class="hljs-keyword">const</span> myConsole = <span class="hljs-keyword">new</span> <span class="hljs-variable language_">console</span>.<span class="hljs-title class_">Console</span>(out, err);
224
225myConsole.<span class="hljs-title function_">log</span>(<span class="hljs-string">'hello world'</span>);
226<span class="hljs-comment">// Prints: hello world, to out</span>
227myConsole.<span class="hljs-title function_">log</span>(<span class="hljs-string">'hello %s'</span>, <span class="hljs-string">'world'</span>);
228<span class="hljs-comment">// Prints: hello world, to out</span>
229myConsole.<span class="hljs-title function_">error</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>(<span class="hljs-string">'Whoops, something bad happened'</span>));
230<span class="hljs-comment">// Prints: [Error: Whoops, something bad happened], to err</span>
231
232<span class="hljs-keyword">const</span> name = <span class="hljs-string">'Will Robinson'</span>;
233myConsole.<span class="hljs-title function_">warn</span>(<span class="hljs-string">`Danger <span class="hljs-subst">${name}</span>! Danger!`</span>);
234<span class="hljs-comment">// Prints: Danger Will Robinson! Danger!, to err</span></code></pre>
235<section><h3>Class: <code>Console</code><span><a class="mark" href="#console_class_console" id="console_class_console">#</a></span></h3>
236<div class="api_metadata">
237<details class="changelog"><summary>History</summary>
238<table>
239<tbody><tr><th>Version</th><th>Changes</th></tr>
240<tr><td>v8.0.0</td>
241<td><p>Errors that occur while writing to the underlying streams will now be ignored by default.</p></td></tr>
242</tbody></table>
243</details>
244</div>
245
246<p>The <code>Console</code> class can be used to create a simple logger with configurable
247output streams and can be accessed using either <code>require('console').Console</code>
248or <code>console.Console</code> (or their destructured counterparts):</p>
249<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Console</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'console'</span>);</code></pre>
250<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-title class_">Console</span> } = <span class="hljs-variable language_">console</span>;</code></pre>
251<h4><code>new Console(stdout[, stderr][, ignoreErrors])</code><span><a class="mark" href="#console_new_console_stdout_stderr_ignoreerrors" id="console_new_console_stdout_stderr_ignoreerrors">#</a></span></h4>
252<h4><code>new Console(options)</code><span><a class="mark" href="#console_new_console_options" id="console_new_console_options">#</a></span></h4>
253<div class="api_metadata">
254<details class="changelog"><summary>History</summary>
255<table>
256<tbody><tr><th>Version</th><th>Changes</th></tr>
257<tr><td>v14.2.0</td>
258<td><p>The <code>groupIndentation</code> option was introduced.</p></td></tr>
259<tr><td>v11.7.0</td>
260<td><p>The <code>inspectOptions</code> option is introduced.</p></td></tr>
261<tr><td>v10.0.0</td>
262<td><p>The <code>Console</code> constructor now supports an <code>options</code> argument, and the <code>colorMode</code> option was introduced.</p></td></tr>
263<tr><td>v8.0.0</td>
264<td><p>The <code>ignoreErrors</code> option was introduced.</p></td></tr>
265</tbody></table>
266</details>
267</div>
268<ul>
269<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a>
270<ul>
271<li><code>stdout</code> <a href="stream.html#stream_class_stream_writable" class="type">&#x3C;stream.Writable></a></li>
272<li><code>stderr</code> <a href="stream.html#stream_class_stream_writable" class="type">&#x3C;stream.Writable></a></li>
273<li><code>ignoreErrors</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type">&#x3C;boolean></a> Ignore errors when writing to the underlying
274streams. <strong>Default:</strong> <code>true</code>.</li>
275<li><code>colorMode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type">&#x3C;boolean></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> Set color support for this <code>Console</code> instance.
276Setting to <code>true</code> enables coloring while inspecting values. Setting to
277<code>false</code> disables coloring while inspecting values. Setting to
278<code>'auto'</code> makes color support depend on the value of the <code>isTTY</code> property
279and the value returned by <code>getColorDepth()</code> on the respective stream. This
280option can not be used, if <code>inspectOptions.colors</code> is set as well.
281<strong>Default:</strong> <code>'auto'</code>.</li>
282<li><code>inspectOptions</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a> Specifies options that are passed along to
283<a href="util.html#util_util_inspect_object_options"><code>util.inspect()</code></a>.</li>
284<li><code>groupIndentation</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type">&#x3C;number></a> Set group indentation.
285<strong>Default:</strong> <code>2</code>.</li>
286</ul>
287</li>
288</ul>
289<p>Creates a new <code>Console</code> with one or two writable stream instances. <code>stdout</code> is a
290writable stream to print log or info output. <code>stderr</code> is used for warning or
291error output. If <code>stderr</code> is not provided, <code>stdout</code> is used for <code>stderr</code>.</p>
292<pre><code class="language-js"><span class="hljs-keyword">const</span> output = fs.<span class="hljs-title function_">createWriteStream</span>(<span class="hljs-string">'./stdout.log'</span>);
293<span class="hljs-keyword">const</span> errorOutput = fs.<span class="hljs-title function_">createWriteStream</span>(<span class="hljs-string">'./stderr.log'</span>);
294<span class="hljs-comment">// Custom simple logger</span>
295<span class="hljs-keyword">const</span> logger = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Console</span>({ <span class="hljs-attr">stdout</span>: output, <span class="hljs-attr">stderr</span>: errorOutput });
296<span class="hljs-comment">// use it like console</span>
297<span class="hljs-keyword">const</span> count = <span class="hljs-number">5</span>;
298logger.<span class="hljs-title function_">log</span>(<span class="hljs-string">'count: %d'</span>, count);
299<span class="hljs-comment">// In stdout.log: count 5</span></code></pre>
300<p>The global <code>console</code> is a special <code>Console</code> whose output is sent to
301<a href="process.html#process_process_stdout"><code>process.stdout</code></a> and <a href="process.html#process_process_stderr"><code>process.stderr</code></a>. It is equivalent to calling:</p>
302<pre><code class="language-js"><span class="hljs-keyword">new</span> <span class="hljs-title class_">Console</span>({ <span class="hljs-attr">stdout</span>: process.<span class="hljs-property">stdout</span>, <span class="hljs-attr">stderr</span>: process.<span class="hljs-property">stderr</span> });</code></pre>
303<h4><code>console.assert(value[, ...message])</code><span><a class="mark" href="#console_console_assert_value_message" id="console_console_assert_value_message">#</a></span></h4>
304<div class="api_metadata">
305<details class="changelog"><summary>History</summary>
306<table>
307<tbody><tr><th>Version</th><th>Changes</th></tr>
308<tr><td>v10.0.0</td>
309<td><p>The implementation is now spec compliant and does not throw anymore.</p></td></tr>
310<tr><td>v0.1.101</td>
311<td><p><span>Added in: v0.1.101</span></p></td></tr>
312</tbody></table>
313</details>
314</div>
315<ul>
316<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a> The value tested for being truthy.</li>
317<li><code>...message</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a> All arguments besides <code>value</code> are used as error message.</li>
318</ul>
319<p><code>console.assert()</code> writes a message if <code>value</code> is <a href="https://developer.mozilla.org/en-US/docs/Glossary/Falsy">falsy</a> or omitted. It only
320writes a message and does not otherwise affect execution. The output always
321starts with <code>"Assertion failed"</code>. If provided, <code>message</code> is formatted using
322<a href="util.html#util_util_format_format_args"><code>util.format()</code></a>.</p>
323<p>If <code>value</code> is <a href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a>, nothing happens.</p>
324<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">assert</span>(<span class="hljs-literal">true</span>, <span class="hljs-string">'does nothing'</span>);
325
326<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">assert</span>(<span class="hljs-literal">false</span>, <span class="hljs-string">'Whoops %s work'</span>, <span class="hljs-string">'didn\'t'</span>);
327<span class="hljs-comment">// Assertion failed: Whoops didn't work</span>
328
329<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">assert</span>();
330<span class="hljs-comment">// Assertion failed</span></code></pre>
331<h4><code>console.clear()</code><span><a class="mark" href="#console_console_clear" id="console_console_clear">#</a></span></h4>
332<div class="api_metadata">
333<span>Added in: v8.3.0</span>
334</div>
335<p>When <code>stdout</code> is a TTY, calling <code>console.clear()</code> will attempt to clear the
336TTY. When <code>stdout</code> is not a TTY, this method does nothing.</p>
337<p>The specific operation of <code>console.clear()</code> can vary across operating systems
338and terminal types. For most Linux operating systems, <code>console.clear()</code>
339operates similarly to the <code>clear</code> shell command. On Windows, <code>console.clear()</code>
340will clear only the output in the current terminal viewport for the Node.js
341binary.</p>
342<h4><code>console.count([label])</code><span><a class="mark" href="#console_console_count_label" id="console_console_count_label">#</a></span></h4>
343<div class="api_metadata">
344<span>Added in: v8.3.0</span>
345</div>
346<ul>
347<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> The display label for the counter. <strong>Default:</strong> <code>'default'</code>.</li>
348</ul>
349<p>Maintains an internal counter specific to <code>label</code> and outputs to <code>stdout</code> the
350number of times <code>console.count()</code> has been called with the given <code>label</code>.</p>
351<!-- eslint-skip -->
352<pre><code class="language-js">> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>()
353<span class="hljs-attr">default</span>: <span class="hljs-number">1</span>
354<span class="hljs-literal">undefined</span>
355> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>(<span class="hljs-string">'default'</span>)
356<span class="hljs-attr">default</span>: <span class="hljs-number">2</span>
357<span class="hljs-literal">undefined</span>
358> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>(<span class="hljs-string">'abc'</span>)
359<span class="hljs-attr">abc</span>: <span class="hljs-number">1</span>
360<span class="hljs-literal">undefined</span>
361> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>(<span class="hljs-string">'xyz'</span>)
362<span class="hljs-attr">xyz</span>: <span class="hljs-number">1</span>
363<span class="hljs-literal">undefined</span>
364> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>(<span class="hljs-string">'abc'</span>)
365<span class="hljs-attr">abc</span>: <span class="hljs-number">2</span>
366<span class="hljs-literal">undefined</span>
367> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>()
368<span class="hljs-attr">default</span>: <span class="hljs-number">3</span>
369<span class="hljs-literal">undefined</span>
370></code></pre>
371<h4><code>console.countReset([label])</code><span><a class="mark" href="#console_console_countreset_label" id="console_console_countreset_label">#</a></span></h4>
372<div class="api_metadata">
373<span>Added in: v8.3.0</span>
374</div>
375<ul>
376<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> The display label for the counter. <strong>Default:</strong> <code>'default'</code>.</li>
377</ul>
378<p>Resets the internal counter specific to <code>label</code>.</p>
379<!-- eslint-skip -->
380<pre><code class="language-js">> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>(<span class="hljs-string">'abc'</span>);
381<span class="hljs-attr">abc</span>: <span class="hljs-number">1</span>
382<span class="hljs-literal">undefined</span>
383> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">countReset</span>(<span class="hljs-string">'abc'</span>);
384<span class="hljs-literal">undefined</span>
385> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">count</span>(<span class="hljs-string">'abc'</span>);
386<span class="hljs-attr">abc</span>: <span class="hljs-number">1</span>
387<span class="hljs-literal">undefined</span>
388></code></pre>
389<h4><code>console.debug(data[, ...args])</code><span><a class="mark" href="#console_console_debug_data_args" id="console_console_debug_data_args">#</a></span></h4>
390<div class="api_metadata">
391<details class="changelog"><summary>History</summary>
392<table>
393<tbody><tr><th>Version</th><th>Changes</th></tr>
394<tr><td>v8.10.0</td>
395<td><p><code>console.debug</code> is now an alias for <code>console.log</code>.</p></td></tr>
396<tr><td>v8.0.0</td>
397<td><p><span>Added in: v8.0.0</span></p></td></tr>
398</tbody></table>
399</details>
400</div>
401<ul>
402<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
403<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
404</ul>
405<p>The <code>console.debug()</code> function is an alias for <a href="#console_console_log_data_args"><code>console.log()</code></a>.</p>
406<h4><code>console.dir(obj[, options])</code><span><a class="mark" href="#console_console_dir_obj_options" id="console_console_dir_obj_options">#</a></span></h4>
407<div class="api_metadata">
408<span>Added in: v0.1.101</span>
409</div>
410<ul>
411<li><code>obj</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
412<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type">&#x3C;Object></a>
413<ul>
414<li><code>showHidden</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type">&#x3C;boolean></a> If <code>true</code> then the object's non-enumerable and symbol
415properties will be shown too. <strong>Default:</strong> <code>false</code>.</li>
416<li><code>depth</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type">&#x3C;number></a> Tells <a href="util.html#util_util_inspect_object_options"><code>util.inspect()</code></a> how many times to recurse while
417formatting the object. This is useful for inspecting large complicated
418objects. To make it recurse indefinitely, pass <code>null</code>. <strong>Default:</strong> <code>2</code>.</li>
419<li><code>colors</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type">&#x3C;boolean></a> If <code>true</code>, then the output will be styled with ANSI color
420codes. Colors are customizable;
421see <a href="util.html#util_customizing_util_inspect_colors">customizing <code>util.inspect()</code> colors</a>. <strong>Default:</strong> <code>false</code>.</li>
422</ul>
423</li>
424</ul>
425<p>Uses <a href="util.html#util_util_inspect_object_options"><code>util.inspect()</code></a> on <code>obj</code> and prints the resulting string to <code>stdout</code>.
426This function bypasses any custom <code>inspect()</code> function defined on <code>obj</code>.</p>
427<h4><code>console.dirxml(...data)</code><span><a class="mark" href="#console_console_dirxml_data" id="console_console_dirxml_data">#</a></span></h4>
428<div class="api_metadata">
429<details class="changelog"><summary>History</summary>
430<table>
431<tbody><tr><th>Version</th><th>Changes</th></tr>
432<tr><td>v9.3.0</td>
433<td><p><code>console.dirxml</code> now calls <code>console.log</code> for its arguments.</p></td></tr>
434<tr><td>v8.0.0</td>
435<td><p><span>Added in: v8.0.0</span></p></td></tr>
436</tbody></table>
437</details>
438</div>
439<ul>
440<li><code>...data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
441</ul>
442<p>This method calls <code>console.log()</code> passing it the arguments received.
443This method does not produce any XML formatting.</p>
444<h4><code>console.error([data][, ...args])</code><span><a class="mark" href="#console_console_error_data_args" id="console_console_error_data_args">#</a></span></h4>
445<div class="api_metadata">
446<span>Added in: v0.1.100</span>
447</div>
448<ul>
449<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
450<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
451</ul>
452<p>Prints to <code>stderr</code> with newline. Multiple arguments can be passed, with the
453first used as the primary message and all additional used as substitution
454values similar to <a href="http://man7.org/linux/man-pages/man3/printf.3.html"><code>printf(3)</code></a> (the arguments are all passed to
455<a href="util.html#util_util_format_format_args"><code>util.format()</code></a>).</p>
456<pre><code class="language-js"><span class="hljs-keyword">const</span> code = <span class="hljs-number">5</span>;
457<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'error #%d'</span>, code);
458<span class="hljs-comment">// Prints: error #5, to stderr</span>
459<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'error'</span>, code);
460<span class="hljs-comment">// Prints: error 5, to stderr</span></code></pre>
461<p>If formatting elements (e.g. <code>%d</code>) are not found in the first string then
462<a href="util.html#util_util_inspect_object_options"><code>util.inspect()</code></a> is called on each argument and the resulting string
463values are concatenated. See <a href="util.html#util_util_format_format_args"><code>util.format()</code></a> for more information.</p>
464<h4><code>console.group([...label])</code><span><a class="mark" href="#console_console_group_label" id="console_console_group_label">#</a></span></h4>
465<div class="api_metadata">
466<span>Added in: v8.5.0</span>
467</div>
468<ul>
469<li><code>...label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
470</ul>
471<p>Increases indentation of subsequent lines by spaces for <code>groupIndentation</code>
472length.</p>
473<p>If one or more <code>label</code>s are provided, those are printed first without the
474additional indentation.</p>
475<h4><code>console.groupCollapsed()</code><span><a class="mark" href="#console_console_groupcollapsed" id="console_console_groupcollapsed">#</a></span></h4>
476<div class="api_metadata">
477<span>Added in: v8.5.0</span>
478</div>
479<p>An alias for <a href="#console_console_group_label"><code>console.group()</code></a>.</p>
480<h4><code>console.groupEnd()</code><span><a class="mark" href="#console_console_groupend" id="console_console_groupend">#</a></span></h4>
481<div class="api_metadata">
482<span>Added in: v8.5.0</span>
483</div>
484<p>Decreases indentation of subsequent lines by spaces for <code>groupIndentation</code>
485length.</p>
486<h4><code>console.info([data][, ...args])</code><span><a class="mark" href="#console_console_info_data_args" id="console_console_info_data_args">#</a></span></h4>
487<div class="api_metadata">
488<span>Added in: v0.1.100</span>
489</div>
490<ul>
491<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
492<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
493</ul>
494<p>The <code>console.info()</code> function is an alias for <a href="#console_console_log_data_args"><code>console.log()</code></a>.</p>
495<h4><code>console.log([data][, ...args])</code><span><a class="mark" href="#console_console_log_data_args" id="console_console_log_data_args">#</a></span></h4>
496<div class="api_metadata">
497<span>Added in: v0.1.100</span>
498</div>
499<ul>
500<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
501<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
502</ul>
503<p>Prints to <code>stdout</code> with newline. Multiple arguments can be passed, with the
504first used as the primary message and all additional used as substitution
505values similar to <a href="http://man7.org/linux/man-pages/man3/printf.3.html"><code>printf(3)</code></a> (the arguments are all passed to
506<a href="util.html#util_util_format_format_args"><code>util.format()</code></a>).</p>
507<pre><code class="language-js"><span class="hljs-keyword">const</span> count = <span class="hljs-number">5</span>;
508<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'count: %d'</span>, count);
509<span class="hljs-comment">// Prints: count: 5, to stdout</span>
510<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'count:'</span>, count);
511<span class="hljs-comment">// Prints: count: 5, to stdout</span></code></pre>
512<p>See <a href="util.html#util_util_format_format_args"><code>util.format()</code></a> for more information.</p>
513<h4><code>console.table(tabularData[, properties])</code><span><a class="mark" href="#console_console_table_tabulardata_properties" id="console_console_table_tabulardata_properties">#</a></span></h4>
514<div class="api_metadata">
515<span>Added in: v10.0.0</span>
516</div>
517<ul>
518<li><code>tabularData</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
519<li><code>properties</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string[]></a> Alternate properties for constructing the table.</li>
520</ul>
521<p>Try to construct a table with the columns of the properties of <code>tabularData</code>
522(or use <code>properties</code>) and rows of <code>tabularData</code> and log it. Falls back to just
523logging the argument if it can’t be parsed as tabular.</p>
524<pre><code class="language-js"><span class="hljs-comment">// These can't be parsed as tabular data</span>
525<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">table</span>(<span class="hljs-title class_">Symbol</span>());
526<span class="hljs-comment">// Symbol()</span>
527
528<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">table</span>(<span class="hljs-literal">undefined</span>);
529<span class="hljs-comment">// undefined</span>
530
531<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">table</span>([{ <span class="hljs-attr">a</span>: <span class="hljs-number">1</span>, <span class="hljs-attr">b</span>: <span class="hljs-string">'Y'</span> }, { <span class="hljs-attr">a</span>: <span class="hljs-string">'Z'</span>, <span class="hljs-attr">b</span>: <span class="hljs-number">2</span> }]);
532<span class="hljs-comment">// ┌─────────┬─────┬─────┐</span>
533<span class="hljs-comment">// │ (index) │  a  │  b  │</span>
534<span class="hljs-comment">// ├─────────┼─────┼─────┤</span>
535<span class="hljs-comment">// │    0    │  1  │ 'Y' │</span>
536<span class="hljs-comment">// │    1    │ 'Z' │  2  │</span>
537<span class="hljs-comment">// └─────────┴─────┴─────┘</span>
538
539<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">table</span>([{ <span class="hljs-attr">a</span>: <span class="hljs-number">1</span>, <span class="hljs-attr">b</span>: <span class="hljs-string">'Y'</span> }, { <span class="hljs-attr">a</span>: <span class="hljs-string">'Z'</span>, <span class="hljs-attr">b</span>: <span class="hljs-number">2</span> }], [<span class="hljs-string">'a'</span>]);
540<span class="hljs-comment">// ┌─────────┬─────┐</span>
541<span class="hljs-comment">// │ (index) │  a  │</span>
542<span class="hljs-comment">// ├─────────┼─────┤</span>
543<span class="hljs-comment">// │    0    │  1  │</span>
544<span class="hljs-comment">// │    1    │ 'Z' │</span>
545<span class="hljs-comment">// └─────────┴─────┘</span></code></pre>
546<h4><code>console.time([label])</code><span><a class="mark" href="#console_console_time_label" id="console_console_time_label">#</a></span></h4>
547<div class="api_metadata">
548<span>Added in: v0.1.104</span>
549</div>
550<ul>
551<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> <strong>Default:</strong> <code>'default'</code></li>
552</ul>
553<p>Starts a timer that can be used to compute the duration of an operation. Timers
554are identified by a unique <code>label</code>. Use the same <code>label</code> when calling
555<a href="#console_console_timeend_label"><code>console.timeEnd()</code></a> to stop the timer and output the elapsed time in
556suitable time units to <code>stdout</code>. For example, if the elapsed
557time is 3869ms, <code>console.timeEnd()</code> displays "3.869s".</p>
558<h4><code>console.timeEnd([label])</code><span><a class="mark" href="#console_console_timeend_label" id="console_console_timeend_label">#</a></span></h4>
559<div class="api_metadata">
560<details class="changelog"><summary>History</summary>
561<table>
562<tbody><tr><th>Version</th><th>Changes</th></tr>
563<tr><td>v13.0.0</td>
564<td><p>The elapsed time is displayed with a suitable time unit.</p></td></tr>
565<tr><td>v6.0.0</td>
566<td><p>This method no longer supports multiple calls that don’t map to individual <code>console.time()</code> calls; see below for details.</p></td></tr>
567<tr><td>v0.1.104</td>
568<td><p><span>Added in: v0.1.104</span></p></td></tr>
569</tbody></table>
570</details>
571</div>
572<ul>
573<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> <strong>Default:</strong> <code>'default'</code></li>
574</ul>
575<p>Stops a timer that was previously started by calling <a href="#console_console_time_label"><code>console.time()</code></a> and
576prints the result to <code>stdout</code>:</p>
577<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">time</span>(<span class="hljs-string">'100-elements'</span>);
578<span class="hljs-keyword">for</span> (<span class="hljs-keyword">let</span> i = <span class="hljs-number">0</span>; i &#x3C; <span class="hljs-number">100</span>; i++) {}
579<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">timeEnd</span>(<span class="hljs-string">'100-elements'</span>);
580<span class="hljs-comment">// prints 100-elements: 225.438ms</span></code></pre>
581<h4><code>console.timeLog([label][, ...data])</code><span><a class="mark" href="#console_console_timelog_label_data" id="console_console_timelog_label_data">#</a></span></h4>
582<div class="api_metadata">
583<span>Added in: v10.7.0</span>
584</div>
585<ul>
586<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a> <strong>Default:</strong> <code>'default'</code></li>
587<li><code>...data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
588</ul>
589<p>For a timer that was previously started by calling <a href="#console_console_time_label"><code>console.time()</code></a>, prints
590the elapsed time and other <code>data</code> arguments to <code>stdout</code>:</p>
591<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">time</span>(<span class="hljs-string">'process'</span>);
592<span class="hljs-keyword">const</span> value = <span class="hljs-title function_">expensiveProcess1</span>(); <span class="hljs-comment">// Returns 42</span>
593<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">timeLog</span>(<span class="hljs-string">'process'</span>, value);
594<span class="hljs-comment">// Prints "process: 365.227ms 42".</span>
595<span class="hljs-title function_">doExpensiveProcess2</span>(value);
596<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">timeEnd</span>(<span class="hljs-string">'process'</span>);</code></pre>
597<h4><code>console.trace([message][, ...args])</code><span><a class="mark" href="#console_console_trace_message_args" id="console_console_trace_message_args">#</a></span></h4>
598<div class="api_metadata">
599<span>Added in: v0.1.104</span>
600</div>
601<ul>
602<li><code>message</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
603<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
604</ul>
605<p>Prints to <code>stderr</code> the string <code>'Trace: '</code>, followed by the <a href="util.html#util_util_format_format_args"><code>util.format()</code></a>
606formatted message and stack trace to the current position in the code.</p>
607<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">trace</span>(<span class="hljs-string">'Show me'</span>);
608<span class="hljs-comment">// Prints: (stack trace will vary based on where trace is called)</span>
609<span class="hljs-comment">//  Trace: Show me</span>
610<span class="hljs-comment">//    at repl:2:9</span>
611<span class="hljs-comment">//    at REPLServer.defaultEval (repl.js:248:27)</span>
612<span class="hljs-comment">//    at bound (domain.js:287:14)</span>
613<span class="hljs-comment">//    at REPLServer.runBound [as eval] (domain.js:300:12)</span>
614<span class="hljs-comment">//    at REPLServer.&#x3C;anonymous> (repl.js:412:12)</span>
615<span class="hljs-comment">//    at emitOne (events.js:82:20)</span>
616<span class="hljs-comment">//    at REPLServer.emit (events.js:169:7)</span>
617<span class="hljs-comment">//    at REPLServer.Interface._onLine (readline.js:210:10)</span>
618<span class="hljs-comment">//    at REPLServer.Interface._line (readline.js:549:8)</span>
619<span class="hljs-comment">//    at REPLServer.Interface._ttyWrite (readline.js:826:14)</span></code></pre>
620<h4><code>console.warn([data][, ...args])</code><span><a class="mark" href="#console_console_warn_data_args" id="console_console_warn_data_args">#</a></span></h4>
621<div class="api_metadata">
622<span>Added in: v0.1.100</span>
623</div>
624<ul>
625<li><code>data</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
626<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type">&#x3C;any></a></li>
627</ul>
628<p>The <code>console.warn()</code> function is an alias for <a href="#console_console_error_data_args"><code>console.error()</code></a>.</p>
629</section><section><h3>Inspector only methods<span><a class="mark" href="#console_inspector_only_methods" id="console_inspector_only_methods">#</a></span></h3>
630<p>The following methods are exposed by the V8 engine in the general API but do
631not display anything unless used in conjunction with the <a href="debugger.html">inspector</a>
632(<code>--inspect</code> flag).</p>
633<h4><code>console.profile([label])</code><span><a class="mark" href="#console_console_profile_label" id="console_console_profile_label">#</a></span></h4>
634<div class="api_metadata">
635<span>Added in: v8.0.0</span>
636</div>
637<ul>
638<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a></li>
639</ul>
640<p>This method does not display anything unless used in the inspector. The
641<code>console.profile()</code> method starts a JavaScript CPU profile with an optional
642label until <a href="#console_console_profileend_label"><code>console.profileEnd()</code></a> is called. The profile is then added to
643the <strong>Profile</strong> panel of the inspector.</p>
644<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">profile</span>(<span class="hljs-string">'MyLabel'</span>);
645<span class="hljs-comment">// Some code</span>
646<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">profileEnd</span>(<span class="hljs-string">'MyLabel'</span>);
647<span class="hljs-comment">// Adds the profile 'MyLabel' to the Profiles panel of the inspector.</span></code></pre>
648<h4><code>console.profileEnd([label])</code><span><a class="mark" href="#console_console_profileend_label" id="console_console_profileend_label">#</a></span></h4>
649<div class="api_metadata">
650<span>Added in: v8.0.0</span>
651</div>
652<ul>
653<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a></li>
654</ul>
655<p>This method does not display anything unless used in the inspector. Stops the
656current JavaScript CPU profiling session if one has been started and prints
657the report to the <strong>Profiles</strong> panel of the inspector. See
658<a href="#console_console_profile_label"><code>console.profile()</code></a> for an example.</p>
659<p>If this method is called without a label, the most recently started profile is
660stopped.</p>
661<h4><code>console.timeStamp([label])</code><span><a class="mark" href="#console_console_timestamp_label" id="console_console_timestamp_label">#</a></span></h4>
662<div class="api_metadata">
663<span>Added in: v8.0.0</span>
664</div>
665<ul>
666<li><code>label</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&#x3C;string></a></li>
667</ul>
668<p>This method does not display anything unless used in the inspector. The
669<code>console.timeStamp()</code> method adds an event with the label <code>'label'</code> to the
670<strong>Timeline</strong> panel of the inspector.</p></section>
671        <!-- API END -->
672      </div>
673    </div>
674  </div>
675  <script>
676    'use strict';
677    {
678      const kCustomPreference = 'customDarkTheme';
679      const userSettings = sessionStorage.getItem(kCustomPreference);
680      const themeToggleButton = document.getElementById('theme-toggle-btn');
681      if (userSettings === null && window.matchMedia) {
682        const mq = window.matchMedia('(prefers-color-scheme: dark)');
683        if ('onchange' in mq) {
684          function mqChangeListener(e) {
685            document.body.classList.toggle('dark-mode', e.matches);
686          }
687          mq.addEventListener('change', mqChangeListener);
688          if (themeToggleButton) {
689            themeToggleButton.addEventListener('click', function() {
690              mq.removeEventListener('change', mqChangeListener);
691            }, { once: true });
692          }
693        }
694        if (mq.matches) {
695          document.body.classList.add('dark-mode');
696        }
697      } else if (userSettings === 'true') {
698        document.body.classList.add('dark-mode');
699      }
700      if (themeToggleButton) {
701        themeToggleButton.hidden = false;
702        themeToggleButton.addEventListener('click', function() {
703          sessionStorage.setItem(
704            kCustomPreference,
705            document.body.classList.toggle('dark-mode')
706          );
707        });
708      }
709    }
710  </script>
711</body>
712</html>
713