The console module provides a simple debugging console that is similar to the\nJavaScript console mechanism provided by web browsers.
The module exports two specific components:
\nConsole class with methods such as console.log(), console.error() and\nconsole.warn() that can be used to write to any Node.js stream.console instance configured to write to process.stdout and\nprocess.stderr. The global console can be used without calling\nrequire('console').Warning: The global console object'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 note on process I/O for\nmore information.
\nExample using the global console:
console.log('hello world');\n// Prints: hello world, to stdout\nconsole.log('hello %s', 'world');\n// Prints: hello world, to stdout\nconsole.error(new Error('Whoops, something bad happened'));\n// Prints: [Error: Whoops, something bad happened], to stderr\n\nconst name = 'Will Robinson';\nconsole.warn(`Danger ${name}! Danger!`);\n// Prints: Danger Will Robinson! Danger!, to stderr\nExample using the Console class:
const out = getStreamSomehow();\nconst err = getStreamSomehow();\nconst myConsole = new console.Console(out, err);\n\nmyConsole.log('hello world');\n// Prints: hello world, to out\nmyConsole.log('hello %s', 'world');\n// Prints: hello world, to out\nmyConsole.error(new Error('Whoops, something bad happened'));\n// Prints: [Error: Whoops, something bad happened], to err\n\nconst name = 'Will Robinson';\nmyConsole.warn(`Danger ${name}! Danger!`);\n// Prints: Danger Will Robinson! Danger!, to err\nThe Console class can be used to create a simple logger with configurable\noutput streams and can be accessed using either require('console').Console\nor console.Console (or their destructured counterparts):
const { Console } = require('console');\nconst { Console } = console;\nA simple assertion test that verifies whether value is truthy. If it is not,\nan AssertionError is thrown. If provided, the error message is formatted\nusing util.format() and used as the error message.
console.assert(true, 'does nothing');\n// OK\nconsole.assert(false, 'Whoops %s', 'didn\\'t work');\n// AssertionError: Whoops didn't work\nThe console.assert() method is implemented differently in Node.js than the\nconsole.assert() method available in browsers.
Specifically, in browsers, calling console.assert() with a falsy\nassertion will cause the message to be printed to the console without\ninterrupting execution of subsequent code. In Node.js, however, a falsy\nassertion will cause an AssertionError to be thrown.
Functionality approximating that implemented by browsers can be implemented\nby extending Node.js' console and overriding the console.assert() method.
In the following example, a simple module is created that extends and overrides\nthe default behavior of console in Node.js.
'use strict';\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;\nThis can then be used as a direct replacement for the built in console:
\nconst console = require('./myConsole');\nconsole.assert(false, 'this message will print, but no error thrown');\nconsole.log('this will also print');\nWhen stdout is a TTY, calling console.clear() will attempt to clear the\nTTY. When stdout is not a TTY, this method does nothing.
The specific operation of console.clear() can vary across operating systems\nand terminal types. For most Linux operating systems, console.clear()\noperates similarly to the clear shell command. On Windows, console.clear()\nwill clear only the output in the current terminal viewport for the Node.js\nbinary.
Maintains an internal counter specific to label and outputs to stdout the\nnumber of times console.count() has been called with the given label.
> console.count()\ndefault: 1\nundefined\n> console.count('default')\ndefault: 2\nundefined\n> console.count('abc')\nabc: 1\nundefined\n> console.count('xyz')\nxyz: 1\nundefined\n> console.count('abc')\nabc: 2\nundefined\n> console.count()\ndefault: 3\nundefined\n>\nResets the internal counter specific to label.
> console.count('abc');\nabc: 1\nundefined\n> console.countReset('abc');\nundefined\n> console.count('abc');\nabc: 1\nundefined\n>\nThe console.debug() function is an alias for console.log().
Uses util.inspect() on obj and prints the resulting string to stdout.\nThis function bypasses any custom inspect() function defined on obj. An\noptional options object may be passed to alter certain aspects of the\nformatted string:
showHidden - if true then the object's non-enumerable and symbol\nproperties will be shown too. Defaults to false.
depth - tells util.inspect() how many times to recurse while\nformatting the object. This is useful for inspecting large complicated objects.\nDefaults to 2. To make it recurse indefinitely, pass null.
colors - if true, then the output will be styled with ANSI color codes.\nDefaults to false. Colors are customizable; see\ncustomizing util.inspect() colors.
This method calls console.log() passing it the arguments received.\nPlease note that this method does not produce any XML formatting.
Prints to stderr 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\nutil.format()).
const code = 5;\nconsole.error('error #%d', code);\n// Prints: error #5, to stderr\nconsole.error('error', code);\n// Prints: error 5, to stderr\nIf formatting elements (e.g. %d) are not found in the first string then\nutil.inspect() is called on each argument and the resulting string\nvalues are concatenated. See util.format() for more information.
Increases indentation of subsequent lines by two spaces.
\nIf one or more labels are provided, those are printed first without the\nadditional indentation.
An alias for console.group().
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 console.info() function is an alias for console.log().
Prints to stdout 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\nutil.format()).
const count = 5;\nconsole.log('count: %d', count);\n// Prints: count: 5, to stdout\nconsole.log('count:', count);\n// Prints: count: 5, to stdout\nSee util.format() for more information.
Starts a timer that can be used to compute the duration of an operation. Timers\nare identified by a unique label. Use the same label when calling\nconsole.timeEnd() to stop the timer and output the elapsed time in\nmilliseconds to stdout. Timer durations are accurate to the sub-millisecond.
Stops a timer that was previously started by calling console.time() and\nprints the result to stdout:
console.time('100-elements');\nfor (let i = 0; i < 100; i++) {}\nconsole.timeEnd('100-elements');\n// prints 100-elements: 225.438ms\nPrints to stderr the string 'Trace :', followed by the util.format()\nformatted message and stack trace to the current position in the code.
console.trace('Show me');\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.<anonymous> (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)\nThe console.warn() function is an alias for console.error().
Creates a new Console with one or two writable stream instances. stdout is a\nwritable stream to print log or info output. stderr is used for warning or\nerror output. If stderr is not provided, stdout is used for stderr.
const output = fs.createWriteStream('./stdout.log');\nconst errorOutput = fs.createWriteStream('./stderr.log');\n// custom simple logger\nconst logger = new Console(output, errorOutput);\n// use it like console\nconst count = 5;\nlogger.log('count: %d', count);\n// in stdout.log: count 5\nThe global console is a special Console whose output is sent to\nprocess.stdout and process.stderr. It is equivalent to calling:
new Console(process.stdout, process.stderr);\nCreates a new Console with one or two writable stream instances. stdout is a\nwritable stream to print log or info output. stderr is used for warning or\nerror output. If stderr is not provided, stdout is used for stderr.
const output = fs.createWriteStream('./stdout.log');\nconst errorOutput = fs.createWriteStream('./stderr.log');\n// custom simple logger\nconst logger = new Console(output, errorOutput);\n// use it like console\nconst count = 5;\nlogger.log('count: %d', count);\n// in stdout.log: count 5\nThe global console is a special Console whose output is sent to\nprocess.stdout and process.stderr. It is equivalent to calling:
new Console(process.stdout, process.stderr);\nThe following methods are exposed by the V8 engine in the general API but do\nnot display anything unless used in conjunction with the inspector\n(--inspect flag).
This method does not display anything unless used in the inspector. The\nconsole.markTimeline() method is the deprecated form of \nconsole.timeStamp().
This method does not display anything unless used in the inspector. The\nconsole.profile() method starts a JavaScript CPU profile with an optional\nlabel until console.profileEnd() is called. The profile is then added to\nthe Profile panel of the inspector.
console.profile('MyLabel');\n// Some code\nconsole.profileEnd();\n// Adds the profile 'MyLabel' to the Profiles panel of the inspector.\nThis 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\nconsole.profile() for an example.
This method does not display anything unless used in the inspector. Prints to\nstdout the array array formatted as a table.
This method does not display anything unless used in the inspector. The\nconsole.timeStamp() method adds an event with the label label to the\nTimeline panel of the inspector.
This method does not display anything unless used in the inspector. The\nconsole.timeline() method is the deprecated form of console.time().
This method does not display anything unless used in the inspector. The\nconsole.timelineEnd() method is the deprecated form of \nconsole.timeEnd().