Muokkaa

Jaa

Console tool utility functions and selectors

  • Artikkeli

The Console Utilities API contains a collection of convenience variables and functions for performing common tasks, such as:

  • Selecting and inspecting DOM elements.
  • Displaying data in a readable format.
  • Stopping and starting the profiler.
  • Monitoring DOM events.

These variables and functions only work by entering them directly into the DevTools Console; you can't use the variables and call the functions from scripts.

Summary

Variable or function Description
Recently evaluated expression: $_ Returns the value of the most recently evaluated expression.
Recently selected element or JavaScript object: $0-$4 Returns a recently selected element or JavaScript object.
Query selector: $(selector) Query selector; returns the reference to the first DOM element with the specified CSS selector, like document.querySelector().
Query selector all: $$(selector, [startNode]) Query selector all; returns an array of elements that match the specified CSS selector, like document.querySelectorAll().
XPath: $x(path, [startNode]) Returns an array of DOM elements that match the specified XPath expression.
clear() Clears the console of its history.
copy(object) Copies a string representation of the specified object to the clipboard.
debug(function) When the specified function is called, the debugger is invoked and breaks inside the function on the Sources panel.
dir(object) Displays an object-style listing of all of the properties for the specified object, like console.dir().
dirxml(object) Prints an XML representation of the specified object, as displayed in the Elements tool, like console.dirxml().
inspect(object/function) Opens and selects the specified DOM element in the Elements tool, or the specified JavaScript heap object in the Memory tool.
getEventListeners(object) Returns the event listeners that are registered on the specified object.
keys(object) Returns an array containing the names of the properties belonging to the specified object.
monitor(function) Logs a message to the console that indicates the function name, along with the arguments passed to the function as part of a request.
monitorEvents(object[, events]) When one of the specified events occurs on the specified object, the event object is logged to the console.
profile([name]) Starts a JavaScript CPU profiling session with an optional name.
profileEnd([name]) Completes a JavaScript CPU profiling session and displays the results in the Performance tool.
queryObjects(constructor) Returns an array of the objects that were created by the specified constructor.
table(data[, columns]) Logs object data, formatted as a table with column headings, for the specified data object.
undebug(function) Stops the debug of the specified function, so that when the function is requested, the debugger is no longer invoked.
unmonitor(function) Stops the monitoring of the specified function.
unmonitorEvents(object[, events]) Stops monitoring events for the specified object and events.
values(object) Returns an array containing the values of all properties belonging to the specified object.

Recently evaluated expression: $_

$_ returns the value of the most recently evaluated expression.

Syntax:

$_

Example 1

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type the expression 2+2, and then press Enter.

    The expression is evaluated, and the result is shown. The $_ variable is also set to the result of the expression.

  3. Type $_, and then press Enter:

    The Console tool showing that the $_ variable returns the result of the previous expression

Example 2

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. Paste the following code into the Console, and then press Enter:

    ["john", "paul", "george", "ringo"]

    The evaluated expression is an array of names.

  3. Type the following code into the Console, and then press Enter:

    $_.length

    The expression $_.length is evaluated and 4 is shown in the Console because $_ refers to the previously evaluated expression, which is the array of names. $_.length is the length of the array of names.

  4. Type the following code into the Console, and then press Enter:

    $_

    $_ always refers to the previously evaluated expression, which is now the number 4.

    The value of $_ changes to the value of the previously evaluated expression

Recently selected element or JavaScript object: $0-$4

$0, $1, $2, $3, and $4 return recently selected elements or JavaScript objects.

$0 returns the most recently selected element or JavaScript object, $1 returns the second most recently selected one, and so on. The $0, $1, $2, $3, and $4 variables work as a historical reference to the last five DOM elements that were inspected within the Elements tool, or the last five JavaScript heap objects that were selected in the Memory tool.

Syntax

$0

Example

  1. To open DevTools, right-click the webpage, and then select Inspect. Or, press Ctrl+Shift+I (Windows, Linux) or Command+Option+I (macOS). DevTools opens.

  2. In the Elements tool, select an element, for example an <input> element.

  3. Open the Console tool in the Quick View panel, at the bottom of DevTools.

  4. Type $0 in the Console tool, and then press Enter.

    The $0 variable returns the selected <input> element:

    The result of evaluating the $0 command in the Console

  5. Select a different element in the Elements tool, for example a <div> element.

  6. In the Console tool, type $0, and then press Enter.

    $0 refers to the newly selected element, which is the <div> element.

  7. Type $1, and then press Enter.

    $1 refers to the previously selected element, which is the <input> element:

    The result of evaluating the $0 and the $1 commands

Query selector: $(selector)

$(selector) returns the reference to the first DOM element that matches the specified CSS selector selector.

This function is similar to the document.querySelector() function.

If you are using a library such as jQuery that uses $, the functionality is overwritten, and $ corresponds to the implementation from that library.

Syntax

$(selector, [parentElement])

Example 1

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type $('input'). The first element that matches the input CSS selector is displayed:

    $('input') returns a reference to the first element in the webpage

  3. Right-click the returned result and then select Reveal in Elements Panel to find it in the DOM, or Scroll in to View to show it on the page.

Example 2

The $() function accepts a second parameter, parentElement, that specifies a parent element which to search in. The default value of the parameter is document, which means that the entire webpage is searched by default. By specifying a parent element, you can search for elements within a specific part of the webpage.

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type $('input', $('ul'))

    The first element that matches the input CSS selector found within the first ul element is retruned:

    The result of $('input', $('ul'))

Query selector all: $$(selector, [startNode])

$$() returns a list of elements that match the specified CSS selector, like document.querySelectorAll().

This function is similar to document.querySelectorAll() but returns an array of element, instead of a NodeList.

Syntax

$$(selector, [parentElement])

Example 1

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type $$('button'). All the <button> elements in the webpage are displayed:

    The result of $$('button')

Example 2

This $$() function also supports a second parameter, parentElement, that specifies a parent element which to search in. The default value of the parameter is document, which means that the entire webpage is searched by default. By specifying a parent element, you can search for elements within a specific part of the webpage.

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type $$('button', $('li.task')). All the <button> elements that are descendants of the first <li class="task"> element are displayed:

    The result of $$('button', $('li.task'))

XPath: $x(path, [startNode])

$x(path) returns an array of DOM elements that match the specified XPath expression path.

Syntax

$x(path, [parentElement])

Example 1

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type $x("//li"). All the <li> elements in the webpage are displayed:

    Using an XPath selector

Example 2

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, type $x("//li[button]"). All the <li> elements that contain <button> elements are displayed:

    Using a more complicated XPath selector

Similar to the other selector commands, $x(path) has an optional second parameter, parentElement, that specifies an element or node in which to search for elements.

clear()

clear() clears the console of its history.

Syntax

clear()

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. To create history in the Console tool, enter multiple JavaScript expressions. For example:

    for (let i = 0; i < 10; i++) {
    console.log(i);
}

  3. To clear the history, type clear() in the Console tool, and then press Enter:

    The result of the clear() command, the console is empty and the message "console was cleared" appears

copy(object)

copy(object) copies a string representation of the specified object to the clipboard.

Syntax

copy(object)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. Enter the following code in the Console tool, and then press Enter:

    copy($$('*').map(element => element.tagName));

    The code snippet selects all elements in the webpage by using the $$(selector) function, and then maps the tagName property of each element to an array. The array is then copied to the clipboard by using the copy() function.

  3. Paste the contents of the clipboard into a text editor. The contents of the clipboard is a list of all the HTML tags in the webpage, for example:

    ["HTML", "HEAD", "META", "TITLE", "LINK", "BODY", "H1", "FORM", "DIV", "LABEL", ...]

debug(function)

debug(function) pauses inside the specified function function in the Sources tool, when that function is called.

After the debugger is paused, you can then step through the code and debug it.

Syntax

debug(function)

Example

  1. Open a new tab or window, and then go to a page that contains a JavaScript function you want to debug. For example, go to the TODO app demo page.

  2. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  3. In the Console tool, type debug(updateList).

  4. In the rendered webpage, add a new TODO item to the list by typing test in the Add a task text field and then pressing Enter.

    The debugger pauses inside the updateList() function in the Sources tool:

    The debugger pauses inside the updateList() function

Use undebug(function) to stop breaking on the function, or use the UI to turn off all breakpoints.

For more information on breakpoints, see Pause your code with breakpoints.

dir(object)

dir(object) displays an object-style listing of all of the properties for the specified object, like console.dir().

This function is an alias for console.dir().

Syntax

dir(object)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter document.head and then press Enter.

    An HTML representation of the <head> element is displayed.

  3. Enter dir(document.head) and then press Enter.

    An object-style listing of all of the properties for the <head> element is displayed:

    Logging 'document.head' with the 'dir()' function

For more information, see console.dir() in the Console API.

dirxml(object)

dirxml(object) prints an XML representation of the specified object, as displayed in the Elements tool, like console.dirxml().

This function is equivalent to console.dirxml().

Syntax

dirxml(object)

inspect(object/function)

inspect(element/function) opens and selects the specified DOM element in the Elements tool, or the specified JavaScript function in the Sources tool.

  • For a DOM element, this function opens and selects the specified DOM element in the Elements tool.
  • For a JavaScript function, this function opens the specified JavaScript function in the Sources tool.

Syntax

inspect(element/function)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter inspect(document.body) and then press Enter.

    The Elements tool opens and the <body> element is selected:

    Inspecting an element with inspect()

When passing a function to inspect, the function opens the webpage in the Sources tool for you to inspect.

getEventListeners(object)

getEventListeners(object) returns the event listeners that are registered on the specified object.

The return value is an object that contains an array for each registered event type (such as click or keydown). The items in each array are objects that describe the listener registered for each type.

Syntax

getEventListeners(object)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter getEventListeners($('form')) and then press Enter.

    The event listeners that are registered on the first <form> element are displayed:

    Output of using getEventListeners(form)

If more than one listener is registered on the specified object, then the array contains a member for each listener. In the following figure, two event listeners are registered on the document element for the click event:

Multiple event listeners registered on the 'document' element for the 'click' event

keys(object)

keys(object) returns an array containing the names of the properties belonging to the specified object.

To get the associated values of the same properties, see values(object), below.

Syntax

keys(object)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter the following code, and then press Enter:

    var player1 = {"name": "Ted", "level": 42}

    The above code snippet defines an object in the global namespace named player1, which contains two properties.

  3. To get the names of the properties belonging to the player1 object, enter keys(player1) in the Console tool, and then press Enter:

    The result of the keys() function

  4. To get the values of the properties belonging to the player1 object, enter values(player1) in the Console tool, and then press Enter:

    The result of the values() function

monitor(function)

monitor(function) logs a message to the console everytime the specified function is called. The message indicates the function name and the arguments passed to the function.

Syntax

monitor(function)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter the following code and then press Enter:

    function sum(x, y) {
  return x + y;
}

    The above code snippet defines a function named sum, which accepts two arguments.

  3. To start monitoring the sum function, enter monitor(sum) in the Console tool, and then press Enter:

  4. To call the function, enter sum(1, 2) and press Enter. A message appears, indicating that the sum function was called, and the arguments passed to the function:

    The result of the monitor() function

To end monitoring, use unmonitor(function).

monitorEvents(object[, events])

monitorEvents(object[, events]) logs an event object to the console every time the specified events occur on the specified object.

You can specify a single event to monitor, an array of events, or one of the generic events types that are mapped to a predefined collection of events.

Syntax

monitorEvents(object[, events])

Example 1

To monitor a single event:

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter the following code and then press Enter:

    monitorEvents(window, "resize");

    The previous code snippet monitors all resize events on the window object.

  3. Resize the window, for example by making DevTools larger or smaller. Resize events appear in the Console tool:

    Monitoring window resize events

Example 2

To monitor multiple events:

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter the following code and then press Enter:

    monitorEvents(window, ["resize", "scroll"]);

    The previous code snippet defines an array of event names to monitor both resize and scroll eevents on the window object.

  3. Resize the window, for example by making it shorter, and then scroll in the rendered webpage. Resize and scroll events appear in the Console tool:

    Monitoring window resize and scroll events

Example 3

You can also specify a collection of events by using one of the predefined sets of events. The following table shows the available event types and the associated event mappings:

Event type Corresponding mapped events
mouse "click", "dblclick", "mousedown", "mousemove", "mouseout", "mouseover", "mouseup", "mousewheel"
key "keydown", "keypress", "keyup", "textInput"
touch "touchcancel", "touchend", "touchmove", "touchstart"
control "blur", "change", "focus", "reset", "resize", "scroll", "select", "submit", "zoom"

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. In the Console tool, enter the following code and then press Enter:

    monitorEvents(window, "key");

    The previous code snippet monitors all keyboard events on the window object.

  3. In the rendered webpage, press any keys. Keyboard events appear in the Console tool:

    Monitoring key events

profile([name])

profile([name]) starts a JavaScript CPU profiling session with an optional name.

To complete the profile and display the results in the Performance tool, call profileEnd([name]).

Syntax

profile([name])

Example

  1. Open the page that you want to profile in a new tab or window. For example, go to the Sluggish Animation demo page.

  2. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  3. To start profiling, in the Console tool, type profile("My profile), and then press Enter.

  4. To stop profiling, after some time has passed, type profileEnd("My profile"), and then press Enter.

    The profile results appear in the Performance tool:

    The result of the profile() function

You can create multiple profiles at the same time, and you aren't required to end each profile in creation order. For example, the following code creates two profiles, and then ends them in the opposite order:

profile('A');
profile('B');
profileEnd('B');
profileEnd('A');

profileEnd([name])

profileEnd([name]) completes a JavaScript CPU profiling session and displays the results in the Performance tool.

To call this function, you must be running the profile([name]) function.

Syntax

profileEnd([name])

For more information, see profile([name]), above.

queryObjects(constructor)

queryObjects(constructor) returns an array of the objects that were created by the specified constructor.

The scope of queryObjects() is the currently selected runtime context in the Console.

Syntax

queryObjects(constructor)

Example

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. To return all instances of HTML elements, enter queryObjects(HTMLElement) in the Console tool, and then press Enter:

    The result of the queryObjects() function

Other examples:

  • Use queryObjects(Promise) to return all instances of Promise objects if your webpage uses Promise objects.
  • Use queryObjects(ClassName) to return all instances of the ClassName class if your webpage uses JavaScript classes.

table(data[, columns])

table(data[, columns]) logs object data, formatted as a table with column headings, for the specified data object.

This function is an alias for console.table().

Syntax

table(data[, columns])

Example

To display a list of people's names as a table, in the Console:

  1. Press Ctrl+Shift+J (Windows, Linux) or Command+Option+J (macOS). The Console tool opens in DevTools, next to the webpage.

  2. Enter the following code in the Console, and then press Enter:

    var names = {
  0: {
    firstName: "John",
    lastName: "Smith"
  },
  1:  {
    firstName: "Jane",
    lastName: "Doe"
  }
};

    The above code snippet defines an object in the global namespace named names, which contains two properties.

  3. To display the names object as a table, enter table(names) in the Console, and then press Enter:

    The result of the table() function

undebug(function)

undebug(function) stops the debug of the specified function, so that when the function runs, the debugger no longer pauses in the function.

For more information, see debug(function), above.

Syntax

undebug(function)

unmonitor(function)

unmonitor(function) stops the monitoring of the specified function.

For more information, see monitor(function), above.

Syntax

unmonitor(function)

unmonitorEvents(object[, events])

unmonitorEvents(object[, events]) stops monitoring events for the specified object and events.

For more information, see monitorEvents(object[, events]), above.

Syntax

unmonitorEvents(object[, events])

values(object)

values(object) returns an array containing the values of all properties belonging to the specified object.

To get the associated keys of the same properties, see keys(object), above.

Syntax

values(object)

Example

See the example in keys(object), above.

See also

Note

Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons Attribution 4.0 International License. The original page is found here and is authored by Kayce Basques.

Creative Commons License This work is licensed under a Creative Commons Attribution 4.0 International License.