✏️ Editing: console.json Read Only

{
 "source": "doc/api/console.md",
 "modules": [
 {
 "textRaw": "Console",
 "name": "console",
 "introduced_in": "v0.10.13",
 "stability": 2,
 "stabilityText": "Stable",
 "desc": "The <code>console</code> module provides a simple debugging console that is similar to the\nJavaScript console mechanism provided by web browsers.\nThe module exports two specific components:\n<ul>\n<li>A <code>Console</code> class with methods such as <code>console.log()</code>, <code>console.error()</code> and\n<code>console.warn()</code> that can be used to write to any Node.js stream.</li>\n<li>A global <code>console</code> instance configured to write to <a href=\"process.html#process_process_stdout\"><code>process.stdout</code></a> and\n<a href=\"process.html#process_process_stderr\"><code>process.stderr</code></a>. The global <code>console</code> can be used without calling\n<code>require(&#39;console&#39;)</code>.</li>\n</ul>\nWarning: The global console object&#39;s methods are neither consistently\nsynchronous like the browser APIs they resemble, nor are they consistently\nasynchronous 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\nmore information.\nExample using the global <code>console</code>:\n<pre><code class=\"lang-js\">console.log(&#39;hello world&#39;);\n// Prints: hello world, to stdout\nconsole.log(&#39;hello %s&#39;, &#39;world&#39;);\n// Prints: hello world, to stdout\nconsole.error(new Error(&#39;Whoops, something bad happened&#39;));\n// Prints: [Error: Whoops, something bad happened], to stderr\n\nconst name = &#39;Will Robinson&#39;;\nconsole.warn(`Danger ${name}! Danger!`);\n// Prints: Danger Will Robinson! Danger!, to stderr\n</code></pre>\nExample using the <code>Console</code> class:\n<pre><code class=\"lang-js\">const out = getStreamSomehow();\nconst err = getStreamSomehow();\nconst myConsole = new console.Console(out, err);\n\nmyConsole.log(&#39;hello world&#39;);\n// Prints: hello world, to out\nmyConsole.log(&#39;hello %s&#39;, &#39;world&#39;);\n// Prints: hello world, to out\nmyConsole.error(new Error(&#39;Whoops, something bad happened&#39;));\n// Prints: [Error: Whoops, something bad happened], to err\n\nconst name = &#39;Will Robinson&#39;;\nmyConsole.warn(`Danger ${name}! Danger!`);\n// Prints: Danger Will Robinson! Danger!, to err\n</code></pre>\n",
 "classes": [
 {
 "textRaw": "Class: Console",
 "type": "class",
 "name": "Console",
 "meta": {
 "changes": [
 {
 "version": "v8.0.0",
 "pr-url": "https://github.com/nodejs/node/pull/9744",
 "description": "Errors that occur while writing to the underlying streams will now be ignored."
 }
 ]
 },
 "desc": "The <code>Console</code> class can be used to create a simple logger with configurable\noutput streams and can be accessed using either <code>require(&#39;console&#39;).Console</code>\nor <code>console.Console</code> (or their destructured counterparts):\n<pre><code class=\"lang-js\">const { Console } = require(&#39;console&#39;);\n</code></pre>\n<pre><code class=\"lang-js\">const { Console } = console;\n</code></pre>\n",
 "methods": [
 {
 "textRaw": "console.assert(value[, message][, ...args])",
 "type": "method",
 "name": "assert",
 "meta": {
 "added": [
 "v0.1.101"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`value` {any} ",
 "name": "value",
 "type": "any"
 },
 {
 "textRaw": "`message` {any} ",
 "name": "message",
 "type": "any",
 "optional": true
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "value"
 },
 {
 "name": "message",
 "optional": true
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "A simple assertion test that verifies whether <code>value</code> is truthy. If it is not,\nan <code>AssertionError</code> is thrown. If provided, the error <code>message</code> is formatted\nusing <a href=\"util.html#util_util_format_format_args\"><code>util.format()</code></a> and used as the error message.\n<pre><code class=\"lang-js\">console.assert(true, &#39;does nothing&#39;);\n// OK\nconsole.assert(false, &#39;Whoops %s&#39;, &#39;didn\\&#39;t work&#39;);\n// AssertionError: Whoops didn&#39;t work\n</code></pre>\nThe <code>console.assert()</code> method is implemented differently in Node.js than the\n<code>console.assert()</code> method <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/console/assert\">available in browsers</a>.\nSpecifically, in browsers, calling <code>console.assert()</code> with a falsy\nassertion will cause the <code>message</code> to be printed to the console without\ninterrupting execution of subsequent code. In Node.js, however, a falsy\nassertion will cause an <code>AssertionError</code> to be thrown.\nFunctionality approximating that implemented by browsers can be implemented\nby extending Node.js&#39; <code>console</code> and overriding the <code>console.assert()</code> method.\nIn the following example, a simple module is created that extends and overrides\nthe default behavior of <code>console</code> in Node.js.\n\n<pre><code class=\"lang-js\">&#39;use strict&#39;;\n\n// Creates a simple extension of console with a\n// new impl for assert without monkey-patching.\nconst myConsole = Object.create(console, {\n assert: {\n value: function assert(assertion, message, ...args) {\n try {\n console.assert(assertion, message, ...args);\n } catch (err) {\n console.error(err.stack);\n }\n },\n configurable: true,\n enumerable: true,\n writable: true,\n },\n});\n\nmodule.exports = myConsole;\n</code></pre>\nThis can then be used as a direct replacement for the built in console:\n<pre><code class=\"lang-js\">const console = require(&#39;./myConsole&#39;);\nconsole.assert(false, &#39;this message will print, but no error thrown&#39;);\nconsole.log(&#39;this will also print&#39;);\n</code></pre>\n"
 },
 {
 "textRaw": "console.clear()",
 "type": "method",
 "name": "clear",
 "meta": {
 "added": [
 "v8.3.0"
 ],
 "changes": []
 },
 "desc": "When <code>stdout</code> is a TTY, calling <code>console.clear()</code> will attempt to clear the\nTTY. When <code>stdout</code> is not a TTY, this method does nothing.\nThe specific operation of <code>console.clear()</code> can vary across operating systems\nand terminal types. For most Linux operating systems, <code>console.clear()</code>\noperates similarly to the <code>clear</code> shell command. On Windows, <code>console.clear()</code>\nwill clear only the output in the current terminal viewport for the Node.js\nbinary.\n",
 "signatures": [
 {
 "params": []
 }
 ]
 },
 {
 "textRaw": "console.count([label])",
 "type": "method",
 "name": "count",
 "meta": {
 "added": [
 "v8.3.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} The display label for the counter. Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "The display label for the counter. Defaults to `'default'`.",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "label",
 "optional": true
 }
 ]
 }
 ],
 "desc": "Maintains an internal counter specific to <code>label</code> and outputs to <code>stdout</code> the\nnumber of times <code>console.count()</code> has been called with the given <code>label</code>.\n\n<pre><code class=\"lang-js\">&gt; console.count()\ndefault: 1\nundefined\n&gt; console.count(&#39;default&#39;)\ndefault: 2\nundefined\n&gt; console.count(&#39;abc&#39;)\nabc: 1\nundefined\n&gt; console.count(&#39;xyz&#39;)\nxyz: 1\nundefined\n&gt; console.count(&#39;abc&#39;)\nabc: 2\nundefined\n&gt; console.count()\ndefault: 3\nundefined\n&gt;\n</code></pre>\n"
 },
 {
 "textRaw": "console.countReset([label='default'])",
 "type": "method",
 "name": "countReset",
 "meta": {
 "added": [
 "v8.3.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} The display label for the counter. Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "The display label for the counter. Defaults to `'default'`.",
 "optional": true,
 "default": "'default'"
 }
 ]
 },
 {
 "params": [
 {
 "name": "label",
 "optional": true,
 "default": "'default'"
 }
 ]
 }
 ],
 "desc": "Resets the internal counter specific to <code>label</code>.\n\n<pre><code class=\"lang-js\">&gt; console.count(&#39;abc&#39;);\nabc: 1\nundefined\n&gt; console.countReset(&#39;abc&#39;);\nundefined\n&gt; console.count(&#39;abc&#39;);\nabc: 1\nundefined\n&gt;\n</code></pre>\n"
 },
 {
 "textRaw": "console.debug(data[, ...args])",
 "type": "method",
 "name": "debug",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": [
 {
 "version": "v9.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/17033",
 "description": "`console.debug` is now an alias for `console.log`."
 }
 ]
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`data` {any} ",
 "name": "data",
 "type": "any"
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "data"
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "The <code>console.debug()</code> function is an alias for <a href=\"#console_console_log_data_args\"><code>console.log()</code></a>.\n"
 },
 {
 "textRaw": "console.dir(obj[, options])",
 "type": "method",
 "name": "dir",
 "meta": {
 "added": [
 "v0.1.101"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`obj` {any} ",
 "name": "obj",
 "type": "any"
 },
 {
 "textRaw": "`options` {Object} ",
 "options": [
 {
 "textRaw": "`showHidden` {boolean} ",
 "name": "showHidden",
 "type": "boolean"
 },
 {
 "textRaw": "`depth` {number} ",
 "name": "depth",
 "type": "number"
 },
 {
 "textRaw": "`colors` {boolean} ",
 "name": "colors",
 "type": "boolean"
 }
 ],
 "name": "options",
 "type": "Object",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "obj"
 },
 {
 "name": "options",
 "optional": true
 }
 ]
 }
 ],
 "desc": "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>.\nThis function bypasses any custom <code>inspect()</code> function defined on <code>obj</code>. An\noptional <code>options</code> object may be passed to alter certain aspects of the\nformatted string:\n<ul>\n<li><code>showHidden</code> - if <code>true</code> then the object&#39;s non-enumerable and symbol\nproperties will be shown too. Defaults to <code>false</code>.\n</li>\n<li><code>depth</code> - tells <a href=\"util.html#util_util_inspect_object_options\"><code>util.inspect()</code></a> how many times to recurse while\nformatting the object. This is useful for inspecting large complicated objects.\nDefaults to <code>2</code>. To make it recurse indefinitely, pass <code>null</code>.\n</li>\n<li><code>colors</code> - if <code>true</code>, then the output will be styled with ANSI color codes.\nDefaults to <code>false</code>. Colors are customizable; see\n<a href=\"util.html#util_customizing_util_inspect_colors\">customizing <code>util.inspect()</code> colors</a>.\n</li>\n</ul>\n"
 },
 {
 "textRaw": "console.dirxml(...data)",
 "type": "method",
 "name": "dirxml",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": [
 {
 "version": "v9.3.0",
 "pr-url": "https://github.com/nodejs/node/pull/17152",
 "description": "`console.dirxml` now calls `console.log` for its arguments."
 }
 ]
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`...data` {any} ",
 "name": "...data",
 "type": "any"
 }
 ]
 },
 {
 "params": [
 {
 "name": "...data"
 }
 ]
 }
 ],
 "desc": "This method calls <code>console.log()</code> passing it the arguments received.\nPlease note that this method does not produce any XML formatting.\n"
 },
 {
 "textRaw": "console.error([data][, ...args])",
 "type": "method",
 "name": "error",
 "meta": {
 "added": [
 "v0.1.100"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`data` {any} ",
 "name": "data",
 "type": "any",
 "optional": true
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "data",
 "optional": true
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "Prints to <code>stderr</code> with newline. Multiple arguments can be passed, with the\nfirst used as the primary message and all additional used as substitution\nvalues similar to printf(3) (the arguments are all passed to\n<a href=\"util.html#util_util_format_format_args\"><code>util.format()</code></a>).\n<pre><code class=\"lang-js\">const code = 5;\nconsole.error(&#39;error #%d&#39;, code);\n// Prints: error #5, to stderr\nconsole.error(&#39;error&#39;, code);\n// Prints: error 5, to stderr\n</code></pre>\nIf formatting elements (e.g. <code>%d</code>) are not found in the first string then\n<a href=\"util.html#util_util_inspect_object_options\"><code>util.inspect()</code></a> is called on each argument and the resulting string\nvalues are concatenated. See <a href=\"util.html#util_util_format_format_args\"><code>util.format()</code></a> for more information.\n"
 },
 {
 "textRaw": "console.group([...label])",
 "type": "method",
 "name": "group",
 "meta": {
 "added": [
 "v8.5.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`...label` {any} ",
 "name": "...label",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "...label",
 "optional": true
 }
 ]
 }
 ],
 "desc": "Increases indentation of subsequent lines by two spaces.\nIf one or more <code>label</code>s are provided, those are printed first without the\nadditional indentation.\n"
 },
 {
 "textRaw": "console.groupCollapsed()",
 "type": "method",
 "name": "groupCollapsed",
 "meta": {
 "added": [
 "v8.5.0"
 ],
 "changes": []
 },
 "desc": "An alias for <a href=\"#console_console_group_label\"><code>console.group()</code></a>.\n",
 "signatures": [
 {
 "params": []
 }
 ]
 },
 {
 "textRaw": "console.groupEnd()",
 "type": "method",
 "name": "groupEnd",
 "meta": {
 "added": [
 "v8.5.0"
 ],
 "changes": []
 },
 "desc": "Decreases indentation of subsequent lines by two spaces.\n",
 "signatures": [
 {
 "params": []
 }
 ]
 },
 {
 "textRaw": "console.info([data][, ...args])",
 "type": "method",
 "name": "info",
 "meta": {
 "added": [
 "v0.1.100"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`data` {any} ",
 "name": "data",
 "type": "any",
 "optional": true
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "data",
 "optional": true
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "The <code>console.info()</code> function is an alias for <a href=\"#console_console_log_data_args\"><code>console.log()</code></a>.\n"
 },
 {
 "textRaw": "console.log([data][, ...args])",
 "type": "method",
 "name": "log",
 "meta": {
 "added": [
 "v0.1.100"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`data` {any} ",
 "name": "data",
 "type": "any",
 "optional": true
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "data",
 "optional": true
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "Prints to <code>stdout</code> with newline. Multiple arguments can be passed, with the\nfirst used as the primary message and all additional used as substitution\nvalues similar to printf(3) (the arguments are all passed to\n<a href=\"util.html#util_util_format_format_args\"><code>util.format()</code></a>).\n<pre><code class=\"lang-js\">const count = 5;\nconsole.log(&#39;count: %d&#39;, count);\n// Prints: count: 5, to stdout\nconsole.log(&#39;count:&#39;, count);\n// Prints: count: 5, to stdout\n</code></pre>\nSee <a href=\"util.html#util_util_format_format_args\"><code>util.format()</code></a> for more information.\n"
 },
 {
 "textRaw": "console.time(label)",
 "type": "method",
 "name": "time",
 "meta": {
 "added": [
 "v0.1.104"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "Defaults to `'default'`."
 }
 ]
 },
 {
 "params": [
 {
 "name": "label"
 }
 ]
 }
 ],
 "desc": "Starts a timer that can be used to compute the duration of an operation. Timers\nare identified by a unique <code>label</code>. Use the same <code>label</code> when calling\n<a href=\"#console_console_timeend_label\"><code>console.timeEnd()</code></a> to stop the timer and output the elapsed time in\nmilliseconds to <code>stdout</code>. Timer durations are accurate to the sub-millisecond.\n"
 },
 {
 "textRaw": "console.timeEnd(label)",
 "type": "method",
 "name": "timeEnd",
 "meta": {
 "added": [
 "v0.1.104"
 ],
 "changes": [
 {
 "version": "v6.0.0",
 "pr-url": "https://github.com/nodejs/node/pull/5901",
 "description": "This method no longer supports multiple calls that don’t map to individual `console.time()` calls; see below for details."
 }
 ]
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "Defaults to `'default'`."
 }
 ]
 },
 {
 "params": [
 {
 "name": "label"
 }
 ]
 }
 ],
 "desc": "Stops a timer that was previously started by calling <a href=\"#console_console_time_label\"><code>console.time()</code></a> and\nprints the result to <code>stdout</code>:\n<pre><code class=\"lang-js\">console.time(&#39;100-elements&#39;);\nfor (let i = 0; i &lt; 100; i++) {}\nconsole.timeEnd(&#39;100-elements&#39;);\n// prints 100-elements: 225.438ms\n</code></pre>\n"
 },
 {
 "textRaw": "console.trace([message][, ...args])",
 "type": "method",
 "name": "trace",
 "meta": {
 "added": [
 "v0.1.104"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`message` {any} ",
 "name": "message",
 "type": "any",
 "optional": true
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "message",
 "optional": true
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "Prints to <code>stderr</code> the string <code>&#39;Trace :&#39;</code>, followed by the <a href=\"util.html#util_util_format_format_args\"><code>util.format()</code></a>\nformatted message and stack trace to the current position in the code.\n<pre><code class=\"lang-js\">console.trace(&#39;Show me&#39;);\n// Prints: (stack trace will vary based on where trace is called)\n// Trace: Show me\n// at repl:2:9\n// at REPLServer.defaultEval (repl.js:248:27)\n// at bound (domain.js:287:14)\n// at REPLServer.runBound [as eval] (domain.js:300:12)\n// at REPLServer.&lt;anonymous&gt; (repl.js:412:12)\n// at emitOne (events.js:82:20)\n// at REPLServer.emit (events.js:169:7)\n// at REPLServer.Interface._onLine (readline.js:210:10)\n// at REPLServer.Interface._line (readline.js:549:8)\n// at REPLServer.Interface._ttyWrite (readline.js:826:14)\n</code></pre>\n"
 },
 {
 "textRaw": "console.warn([data][, ...args])",
 "type": "method",
 "name": "warn",
 "meta": {
 "added": [
 "v0.1.100"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`data` {any} ",
 "name": "data",
 "type": "any",
 "optional": true
 },
 {
 "textRaw": "`...args` {any} ",
 "name": "...args",
 "type": "any",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "data",
 "optional": true
 },
 {
 "name": "...args",
 "optional": true
 }
 ]
 }
 ],
 "desc": "The <code>console.warn()</code> function is an alias for <a href=\"#console_console_error_data_args\"><code>console.error()</code></a>.\n"
 }
 ],
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`stdout` {stream.Writable} ",
 "name": "stdout",
 "type": "stream.Writable"
 },
 {
 "textRaw": "`stderr` {stream.Writable} ",
 "name": "stderr",
 "type": "stream.Writable",
 "optional": true
 }
 ],
 "desc": "Creates a new <code>Console</code> with one or two writable stream instances. <code>stdout</code> is a\nwritable stream to print log or info output. <code>stderr</code> is used for warning or\nerror output. If <code>stderr</code> is not provided, <code>stdout</code> is used for <code>stderr</code>.\n<pre><code class=\"lang-js\">const output = fs.createWriteStream(&#39;./stdout.log&#39;);\nconst errorOutput = fs.createWriteStream(&#39;./stderr.log&#39;);\n// custom simple logger\nconst logger = new Console(output, errorOutput);\n// use it like console\nconst count = 5;\nlogger.log(&#39;count: %d&#39;, count);\n// in stdout.log: count 5\n</code></pre>\nThe global <code>console</code> is a special <code>Console</code> whose output is sent to\n<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:\n<pre><code class=\"lang-js\">new Console(process.stdout, process.stderr);\n</code></pre>\n"
 },
 {
 "params": [
 {
 "name": "stdout"
 },
 {
 "name": "stderr",
 "optional": true
 }
 ],
 "desc": "Creates a new <code>Console</code> with one or two writable stream instances. <code>stdout</code> is a\nwritable stream to print log or info output. <code>stderr</code> is used for warning or\nerror output. If <code>stderr</code> is not provided, <code>stdout</code> is used for <code>stderr</code>.\n<pre><code class=\"lang-js\">const output = fs.createWriteStream(&#39;./stdout.log&#39;);\nconst errorOutput = fs.createWriteStream(&#39;./stderr.log&#39;);\n// custom simple logger\nconst logger = new Console(output, errorOutput);\n// use it like console\nconst count = 5;\nlogger.log(&#39;count: %d&#39;, count);\n// in stdout.log: count 5\n</code></pre>\nThe global <code>console</code> is a special <code>Console</code> whose output is sent to\n<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:\n<pre><code class=\"lang-js\">new Console(process.stdout, process.stderr);\n</code></pre>\n"
 }
 ]
 }
 ],
 "modules": [
 {
 "textRaw": "Inspector only methods",
 "name": "inspector_only_methods",
 "desc": "The following methods are exposed by the V8 engine in the general API but do\nnot display anything unless used in conjunction with the <a href=\"debugger.html\">inspector</a>\n(<code>--inspect</code> flag).\n",
 "methods": [
 {
 "textRaw": "console.markTimeline(label)",
 "type": "method",
 "name": "markTimeline",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "Defaults to `'default'`."
 }
 ]
 },
 {
 "params": [
 {
 "name": "label"
 }
 ]
 }
 ],
 "desc": "This method does not display anything unless used in the inspector. The\n<code>console.markTimeline()</code> method is the deprecated form of \n<a href=\"#console_console_timestamp_label\"><code>console.timeStamp()</code></a>.\n"
 },
 {
 "textRaw": "console.profile([label])",
 "type": "method",
 "name": "profile",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} ",
 "name": "label",
 "type": "string",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "label",
 "optional": true
 }
 ]
 }
 ],
 "desc": "This method does not display anything unless used in the inspector. The\n<code>console.profile()</code> method starts a JavaScript CPU profile with an optional\nlabel until <a href=\"#console_console_profileend\"><code>console.profileEnd()</code></a> is called. The profile is then added to\nthe Profile panel of the inspector.\n<pre><code class=\"lang-js\">console.profile(&#39;MyLabel&#39;);\n// Some code\nconsole.profileEnd();\n// Adds the profile &#39;MyLabel&#39; to the Profiles panel of the inspector.\n</code></pre>\n"
 },
 {
 "textRaw": "console.profileEnd()",
 "type": "method",
 "name": "profileEnd",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "desc": "This method does not display anything unless used in the inspector. Stops the\ncurrent JavaScript CPU profiling session if one has been started and prints\nthe report to the Profiles panel of the inspector. See\n<a href=\"#console_console_profile_label\"><code>console.profile()</code></a> for an example.\n",
 "signatures": [
 {
 "params": []
 }
 ]
 },
 {
 "textRaw": "console.table(array[, columns])",
 "type": "method",
 "name": "table",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`array` {Array|Object} ",
 "name": "array",
 "type": "Array|Object"
 },
 {
 "textRaw": "`columns` {Array} ",
 "name": "columns",
 "type": "Array",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "array"
 },
 {
 "name": "columns",
 "optional": true
 }
 ]
 }
 ],
 "desc": "This method does not display anything unless used in the inspector. Prints to\n<code>stdout</code> the array <code>array</code> formatted as a table.\n"
 },
 {
 "textRaw": "console.timeStamp([label])",
 "type": "method",
 "name": "timeStamp",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} ",
 "name": "label",
 "type": "string",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "label",
 "optional": true
 }
 ]
 }
 ],
 "desc": "This method does not display anything unless used in the inspector. The\n<code>console.timeStamp()</code> method adds an event with the label <code>label</code> to the\nTimeline panel of the inspector.\n"
 },
 {
 "textRaw": "console.timeline([label])",
 "type": "method",
 "name": "timeline",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "Defaults to `'default'`.",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "label",
 "optional": true
 }
 ]
 }
 ],
 "desc": "This method does not display anything unless used in the inspector. The\n<code>console.timeline()</code> method is the deprecated form of <a href=\"#console_console_time_label\"><code>console.time()</code></a>.\n"
 },
 {
 "textRaw": "console.timelineEnd([label])",
 "type": "method",
 "name": "timelineEnd",
 "meta": {
 "added": [
 "v8.0.0"
 ],
 "changes": []
 },
 "signatures": [
 {
 "params": [
 {
 "textRaw": "`label` {string} Defaults to `'default'`. ",
 "name": "label",
 "type": "string",
 "desc": "Defaults to `'default'`.",
 "optional": true
 }
 ]
 },
 {
 "params": [
 {
 "name": "label",
 "optional": true
 }
 ]
 }
 ],
 "desc": "This method does not display anything unless used in the inspector. The\n<code>console.timelineEnd()</code> method is the deprecated form of \n<a href=\"#console_console_timeend_label\"><code>console.timeEnd()</code></a>.\n"
 }
 ],
 "type": "module",
 "displayName": "Inspector only methods"
 }
 ],
 "type": "module",
 "displayName": "Console"
 }
 ]
}

✏️ Editing: console.json Read Only

📁 File Manager Pro

📁 File Manager Pro