Console Utilities API 参考文档

Sofia Emelianova
Sofia Emelianova

Console Utilities API 包含一个用于执行以下常见任务的便捷函数集合:选择和检查 DOM 元素、查询对象、以可读格式显示数据、停止和启动分析器、监控 DOM 事件和函数调用等。

在找 console.log()console.error() 和其他 console.* 函数?请参阅 Console API 参考文档

$_

$_ 返回最近评估的表达式的值。

在以下示例中,系统对简单表达式 (2 + 2) 进行求值。然后,系统将评估 $_ 属性,其中包含相同的值:

$_ 是最近评估的表达式。

在下一个示例中,评估的表达式最初包含一个名称数组。评估 $_.length 以发现数组的长度,$_ 中存储的值变为最新评估的表达式,即 4:

$_ 在评估新命令时会发生变化。

$0 - $4

$0$1$2$3$4 命令可用作对 Elements 面板中最后检查的五个 DOM 元素或 Profiles 面板中最后选择的五个 JavaScript 堆对象的历史引用。$0 会返回最近选择的元素或 JavaScript 对象,$1 会返回最近选择的第二个元素,依此类推。

在以下示例中,在 Elements 面板中选择了 img 元素。在 Console 抽屉式导航栏中,$0 已评估,并显示相同的元素:

例如 $0。

下图显示的是在同一个页面中选择的一个不同的元素。$0 现在指的是新选择的元素,而 $1 返回以前选择的元素:

示例:$1。

$(selector [, startNode])

$(selector) 返回对具有指定 CSS 选择器的第一个 DOM 元素的引用。使用一个参数调用此函数时,此函数是 document.querySelector() 函数的快捷方式。

以下示例返回文档中第一个 <img> 元素的引用:

$(&#39;img&#39;) 的示例。

右键点击返回的结果,然后选择 Reveal in Elements Panel 以在 DOM 中查找它,或选择 Scroll in to View 以在页面上显示它。

以下示例返回当前选择的元素的引用,并显示它的 src 属性:

$(&#39;img&#39;).src 示例。

此函数还支持第二个参数 startNode,用于指定要从中搜索元素的“元素”或节点。此参数的默认值为 document

以下示例返回 devsite-header-background 的第一个子元素 img 的引用,并显示其 src 属性:

$(&#39;img&#39;, div).src 的示例。

$$(selector [, startNode])

$$(selector) 会返回与给定 CSS 选择器匹配的元素数组。此命令等同于调用 Array.from(document.querySelectorAll())

以下示例使用 $$() to create an array of all <img> elements in the current document and displays the value of each element's src property:

let images = $$('img');
for (let each of images) {
  console.log(each.src);
}

在所选节点后面当前文档中显示的 使用<!-- notranslate l10n-placeholder: l10n-placeholder3 -->()</code>创建由所有 <code translate=<img> 元素:

let images = $$('img', document.querySelector('.devsite-header-background'));
for (let each of images) {
  console.log(each.src);
}

使用 $() 选择文档中选择 div 元素后面显示的所有图片并显示其来源的示例。

$x(path [, startNode])

$x(path) 返回一个与给定 XPath 表达式匹配的 DOM 元素数组。

例如,以下代码会返回页面上的所有 <p> 元素:

$x("//p")

使用 XPath 选择器的示例。

以下示例会返回包含 <a> 元素的所有 <p> 元素:

$x("//p[a]")

使用较复杂的 XPath 选择器的示例。

与其他选择器函数类似,$x(path) 有一个可选的第二个参数 startNode,用于指定要从中搜索元素的元素或节点。

将 XPath 选择器与 startNode 搭配使用示例。

clear()

clear() 会在控制台中清除其历史记录。

clear();

copy(object)

copy(object) 将指定对象的字符串表示形式复制到剪贴板。

copy($0);

调试(函数)

调用指定的函数时,将触发调试程序,并在 Sources 面板上使函数内部中断,从而允许逐行执行代码并进行调试。

debug(getData);

使用 debug() 在函数内部中断。

使用 undebug(fn) 停止函数中断,或使用界面停用所有断点。

如需详细了解断点,请参阅使用断点暂停代码

dir(object)

dir(object) 会显示所有指定对象的属性的对象样式列表。此方法是 Console API 的 console.dir() 方法的快捷方式。

以下示例展示了直接在命令行中评估 document.body 和使用 dir() 显示相同元素之间的差异:

document.body;
dir(document.body);

包含/不含 dir() 函数的日志记录 document.body。

如需了解详情,请参阅 Console API 中的 console.dir() 条目。

dirxml(object)

dirxml(object) 会输出以 XML 形式表示的指定对象,如 Elements 面板中所示。此方法等同于 console.dirxml() 方法。

inspect(object/function)

inspect(object/function) 在相应的面板中打开并选择指定的元素或对象:针对 DOM 元素使用 Elements 面板,或针对 JavaScript 堆对象使用 Profiles 面板。

以下示例会在 Elements 面板中打开 document.body

inspect(document.body);

使用 inspect() 检查元素。

当传递要检查的函数时,此函数会在 Sources 面板中打开文档以供您检查。

getEventListeners(object)

getEventListeners(object) 会返回在指定对象上注册的事件监听器。返回值是一个对象,其中包含每个已注册事件类型(例如 clickkeydown)对应的数组。每个数组的成员都是描述为每种类型注册的监听器的对象。例如,下面列出了在文档对象上注册的所有事件监听器:

getEventListeners(document);

使用 getEventListeners() 时的输出。

如果在指定对象上注册了多个监听器,则数组为每个监听器都包含一个成员。在以下示例中,在文档元素上为 click 事件注册了两个事件监听器:

多个监听器。

您可以进一步展开每个对象以查看其属性:

展开的监听器对象的视图。

如需了解详情,请参阅检查对象属性

keys(object)

keys(object) 会返回一个数组,其中包含属于指定对象的属性名称。如需获取同一属性的关联值,请使用 values()

例如,假设您的应用定义了以下对象:

let player = {
    "name": "Parzival",
    "number": 1,
    "state": "ready",
    "easterEggs": 3
};

假设在全局命名空间中定义了 player(为简单起见),那么,在控制台中输入 keys(player)values(player) 会生成以下内容:

keys() 和 values() 方法的示例。

monitoring(函数)

调用指定的函数时,系统会向控制台记录一条消息,指明函数名称以及在调用时传递给该函数的参数。

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

monitoring() 方法示例。

使用 unmonitor(function) 停止监控。

monitorEvents(object [, events])

当在指定对象上发生一个指定事件时,将 Event 对象记录到控制台。您可以指定要监控的单个事件、事件数组或映射到预定义事件集合的某个通用事件“类型”。请参阅下面的示例。

以下事件监控 window 对象上的所有调整事件。

monitorEvents(window, "resize");

监控窗口大小调整事件。

以下代码定义了一个数组,以同时监控 window 对象上的“resize”和“scroll”事件:

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

您还可以指定一个可用的事件“类型”,即映射到预定义事件集的字符串。下表列出了可用的事件类型及其相关的事件映射:

事件类型和对应的已映射事件
老鼠“mousedown”“mouseup”“click”“dblclick”“mousemove”“mouseover”“mouseout”“mousewheel”
“keydown”“keyup”“keypress”“textInput”
触控输入“touchstart”“touchmove”“touchend”“touchcancel”
对照组“resize”“scroll”“zoom”“focus”“blur”“select”“change”“submit”“reset”

例如,以下示例为 Elements 面板上当前选择的输入文本字段上的所有对应 key 事件使用使用“key”事件类型。

monitorEvents($0, "key");

下面是在文本字段中输入字符后的一个输出示例:

监控关键事件。

使用 unmonitorEvents(object[, events]) 停止监控。

profile([name]) and profileEnd([name])

profile() 使用可选的名称启动一个 JavaScript CPU 分析会话。profileEnd() 会完成配置文件,并在性能 > 主要轨道中显示结果。

如需开始分析,请按以下步骤操作:

profile("Profile 1")

如需停止分析并在性能 > 主要轨道中查看结果,请执行以下操作:

profileEnd("Profile 1")

效果 > 主要轨道中查看结果:

“效果”主轨道的配置文件 1。

也可以嵌套配置文件。例如,这在任意顺序下都起作用:

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

queryObjects(Constructor)

从控制台调用 queryObjects(Constructor) 可返回使用指定构造函数创建的对象数组。例如:

  • queryObjects(Promise)。返回 Promise 的所有实例。
  • queryObjects(HTMLElement)。返回所有 HTML 元素。
  • queryObjects(foo),其中 foo 是类名称。返回通过 new foo() 实例化的所有对象。

queryObjects() 的范围是控制台中当前所选的执行上下文。

table(data [, columns])

通过传入带可选列标题的数据对象,以表格格式记录对象数据。 这是console.table()的快捷方式。

例如,如需在控制台中显示使用 table 的名称列表,您需要执行以下操作:

let names = [
  { firstName: "John", lastName: "Smith" },
  { firstName: "Jane", lastName: "Doe" },
];
table(names);

table() 方法示例。

undebug(function)

undebug(function) 可停止调试指定函数,以便在调用该函数时,不再调用调试程序。此属性与 debug(fn) 搭配使用。

undebug(getData);

unmonitor(function)

unmonitor(function) 可停止监控指定函数。此属性与 monitor(fn) 搭配使用。

unmonitor(getData);

unmonitorEvents(object [, events])

unmonitorEvents(object[, events]) 会停止监控指定对象和事件的事件。例如,以下命令可停止 window 对象上的所有事件监控:

unmonitorEvents(window);

您也可以有选择地停止监控某个对象上的特定事件。例如,以下代码可开始对当前所选元素上所有鼠标事件的监控,然后停止监控“mousemove”事件(可能会减少控制台输出的噪音):

monitorEvents($0, "mouse");
unmonitorEvents($0, "mousemove");

values(object)

values(object) 会返回一个数组,其中包含属于指定对象的所有属性值。

let player = {
    "name": "Parzival",
    "number": 1,
    "state": "ready",
    "easterEggs": 3
};

values(player);

values(player) 的结果。