Qortora · Search · Indexed page

console.spec.whatwg.orgFetched 2026-08-14T19:29:22Z

Console Standard

Console Standard Console Living Standard — Last Updated 15 March 2026 Participate: GitHub whatwg/console (new issue, open issues) Chat on Matrix Commits: GitHub whatwg/console/commits Snapshot as of this commit @consolelog Tests: web-platform-tests console/ (ongoing work) Trans…

Open original source · Full cached text

Console Standard Console Living Standard — Last Updated 15 March 2026 Participate: GitHub whatwg/console (new issue, open issues) Chat on Matrix Commits: GitHub whatwg/console/commits Snapshot as of this commit @consolelog Tests: web-platform-tests console/ (ongoing work) Translations (non-normative): 日本語 简体中文 한국어 Abstract This specification defines APIs for console debugging facilities. Status This specification is an early work in progress that welcomes feedback to refine toward more precise and compatible definitions. It is also the editors' first specification, so please be kind and constructive. Please join us in the issue tracker for more discussion. 1. Namespace console [Exposed=*] namespace console { // but see namespace object requirements below // Logging undefined assert(optional boolean condition = false, any... data); undefined clear(); undefined debug(any... data); undefined error(any... data); undefined info(any... data); undefined log(any... data); undefined table(optional any tabularData, optional sequence<DOMString> properties); undefined trace(any... data); undefined warn(any... data); undefined dir(optional any item, optional object? options); undefined dirxml(any... data); // Counting undefined count(optional DOMString label = "default"); undefined countReset(optional DOMString label = "default"); // Grouping undefined group(any... data); undefined groupCollapsed(any... data); undefined groupEnd(); // Timing undefined time(optional DOMString label = "default"); undefined timeLog(optional DOMString label = "default", any... data); undefined timeEnd(optional DOMString label = "default"); }; For historical reasons, console is lowercased. It is important that console is always visible and usable to scripts, even if the developer console has not been opened or does not exist. For historical web-compatibility reasons, the namespace object for console must have as its [[Prototype]] an empty object, created as if by ObjectCreate(%ObjectPrototype%), instead of %ObjectPrototype%. 1.1. Logging functions 1.1.1. assert(condition, ...data) If condition is true, return. Let message be a string without any formatting specifiers indicating generically an assertion failure (such as "Assertion failed"). If data is empty, append message to data. Otherwise: Let first be data[0]. If first is not a String, then prepend message to data. Otherwise: Let concat be the concatenation of message, U+003A (:), U+0020 SPACE, and first. Set data[0] to concat. Perform Logger("assert", data). 1.1.2. clear() Empty the appropriate group stack. If possible for the environment, clear the console. (Otherwise, do nothing.) 1.1.3. debug(...data) Perform Logger("debug", data). 1.1.4. error(...data) Perform Logger("error", data). 1.1.5. info(...data) Perform Logger("info", data). 1.1.6. log(...data) Perform Logger("log", data). 1.1.7. table(tabularData, properties) Try to construct a table with the columns of the properties of tabularData (or use properties) and rows of tabularData and log it with a logLevel of "log". Fall back to just logging the argument if it can’t be parsed as tabular. TODO: This will need a good algorithm. 1.1.8. trace(...data) Let trace be some implementation-defined, potentially-interactive representation of the callstack from where this function was called. Optionally, let formattedData be the result of Formatter(data), and incorporate formattedData as a label for trace. Perform Printer("trace", « trace »). The identifier of a function printed in a stack trace is implementation-defined. It is also not guaranteed to be the same identifier that would be seen in new Error().stack. 1.1.9. warn(...data) Perform Logger("warn", data). 1.1.10. dir(item, options) Let object be item with generic JavaScript object formatting applied. Perform Printer("dir", « object », options). 1.1.11. dirxml(...data) Let finalList be a new list, initially empty. For each item of data: Let converted be a DOM tree representation of item if possible; otherwise let converted be item with optimally useful formatting applied. Append converted to finalList. Perform Logger("dirxml", finalList). 1.2. Counting functions Each console namespace object has an associated count map, which is a map of strings to numbers, initially empty. 1.2.1. count(label) Let map be the associated count map. If map[label] exists, set map[label] to map[label] + 1. Otherwise, set map[label] to 1. Let concat be the concatenation of label, U+003A (:), U+0020 SPACE, and ToString(map[label]). Perform Logger("count", « concat »). 1.2.2. countReset(label) Let map be the associated count map. If map[label] exists, set map[label] to 0. Otherwise: Let message be a string without any formatting specifiers indicating generically that the given label does not have an associated count. Perform Logger("countReset", « message »); 1.3. Grouping functions A group is an implementation-defined, potentially-interactive view for output produced by calls to Printer, with one further level of indentation than its parent. Each console namespace object has an associated group stack, which is a stack, initially empty. Only the last group in a group stack will host output produced by calls to Printer. 1.3.1. group(...data) Let group be a new group. If data is not empty, let groupLabel be the result of Formatter(data). Otherwise, let groupLabel be an implementation-chosen label representing a group. Incorporate groupLabel as a label for group. Optionally, if the environment supports interactive groups, group should be expanded by default. Perform Printer("group", « group »). Push group onto the appropriate group stack. 1.3.2. groupCollapsed(...data) Let group be a new group. If data is not empty, let groupLabel be the result of Formatter(data). Otherwise, let groupLabel be an implementation-chosen label representing a group. Incorporate groupLabel as a label for group. Optionally, if the environment supports interactive groups, group should be collapsed by default. Perform Printer("groupCollapsed", « group »). Push group onto the appropriate group stack. 1.3.3. groupEnd() Pop the last group from the group stack. 1.4. Timing functions Each console namespace object has an associated timer table, which is a map of strings to times, initially empty. 1.4.1. time(label) If the associated timer table contains an entry with key label, return, optionally reporting a warning to the console indicating that a timer with label label has already been started. Otherwise, set the value of the entry with key label in the associated timer table to the current time. 1.4.2. timeLog(label, ...data) Let timerTable be the associated timer table. Let startTime be timerTable[label]. Let duration be a string representing the difference between the current time and startTime, in an implementation-defined format. "4650", "4650.69 ms", "5 seconds", and "00:05" are all reasonable ways of displaying a 4650.69 ms duration. Let concat be the concatenation of label, U+003A (:), U+0020 SPACE, and duration. Prepend concat to data. Perform Printer("timeLog", data). The data parameter in calls to timeLog() is included in the call to Logger to make it easier for users to supply intermediate timer logs with some extra data throughout the life of a timer. For example: console.time("MyTimer"); console.timeLog("MyTimer", "Starting application up…"); // Perhaps some code runs to bootstrap a complex app // ... console.timeLog("MyTimer", "UI is setup, making API calls now"); // Perhaps some fetch()'s here filling the app with data // ... console.timeEnd("MyTimer"); 1.4.3. timeEnd(label) Let timerTable be the associated timer table. Let startTime be timerTable[label]. Remove timerTable[label]. Let duration be a string representing the difference between the current time and startTime, in an implementation-defined format. Let concat be the concatenation of label, U+003A (:), U+0020 SPACE, and duration. Perform Printer("timeEnd", « concat »). See whatwg/console#134 for plans to make timeEnd() and timeLog() formally report warnings to the console when a given label does not exist in the associated timer table. 2. Supporting abstract operations 2.1. Logger(logLevel, args) The logger operation accepts a log level and a list of other arguments. Its main output is the implementation-defined side effect of printing the result to the console. This specification describes how it processes format specifiers while doing so. If args is empty, return. Let first be args[0]. Let rest be all elements following first in args. If rest is empty, perform Printer(logLevel, « first ») and return. Otherwise, perform Printer(logLevel, Formatter(args)). Return undefined. It’s important that the printing occurs before returning from the algorithm. Many developer consoles print the result of the last operation entered into them. In such consoles, when a developer enters console.log("hello!"), this will first print "hello!", then the undefined return value from the console.log call. 2.2. Formatter(args) The formatter operation tries to format the first argument provided, using the other arguments. It will try to format the input until no formatting specifiers are left in the first argument, or no more arguments are left. It returns a list of objects suitable for printing. If args’s size is 1, return args. Let target be the first element of args. Let current be the second element of args. Find the first possible format specifier specifier, from the left to the right in target. If no format specifier was found, return args. Otherwise: If specifier is %s, let converted be the result of Call(%String%, undefined, « current »). If specifier is %d or %i: If current is a Symbol, let converted be NaN Otherwise, let converted be the result of Call(%parseInt%, undefined, « current, 10 »). If specifier is %f: If current is a Symbol, let converted be NaN Otherwise, let converted be the result of Call(%parseFloat%, undefined, « current »). If specifier is %o, optionally let converted be current with optimally useful formatting applied. If specifier is %O, optionally let converted be current with generic JavaScript object formatting applied. TODO: process %c If any of the previous steps set converted, replace specifier in target with converted. Let result be a list containing target together with the elements of args starting from the third onward. Return Formatter(result). 2.2.1. Summary of formatting specifiers The following is an informative summary of the format specifiers processed by the above algorithm. Specifier Purpose Type Conversion %s Element which substitutes is converted to a string %String%(element) %d or %i Element which substitutes is converted to an integer %parseInt%(element, 10) %f Element which substitutes is converted to a float %parseFloat%(element, 10) %o Element is displayed with optimally useful formatting n/a %O Element is displayed with generic JavaScript object formatting n/a %c Applies provided CSS n/a 2.3. Printer(logLevel, args[, options]) The printer operation is implementation-defined. It accepts a log level indicating severity, a List of arguments to print, and an optional object of implementation-specific formatting options. Elements appearing in args will be one of the following: JavaScript objects of any type. Implementation-specific representations of printable things such as a stack trace or group. Objects with either generic JavaScript object formatting or optimally useful formatting applied. If the options object is passed, and is not undefined or null, implementations may use options to apply implementation-defined formatting to the elements in args. How the implementation prints args is up to the implementation, but implementations should separate the objects by a space or something similar, as that has become a developer expectation. By the time the printer operation is called, all format specifiers will have been taken into account, and any argumen…