HighlightRegistry: keys() 方法

可用性有限

此功能并非基线功能,因为它在某些使用最广泛的浏览器中无法正常工作。

keys() 方法是 HighlightRegistry 接口的方法,它返回一个新的 迭代器 对象,该对象包含 HighlightRegistry 对象中每个 Highlight 对象的键,插入顺序。

HighlightRegistry 是一个类似于 Map 的对象,因此这类似于使用 Map.keys().

语法

js
keys()

返回值

一个新的迭代器对象,包含注册表中每个 Highlight 对象的名称,插入顺序。

示例

以下代码片段演示了如何创建和注册三个 Highlight 对象,以及如何使用 keys() 方法返回的迭代器记录它们的名称。

js
const fooHighlight = new Highlight();
const barHighlight = new Highlight();
const bazHighlight = new Highlight();

CSS.highlights.set("foo", fooHighlight);
CSS.highlights.set("bar", barHighlight);
CSS.highlights.set("baz", bazHighlight);

const iter = CSS.highlights.keys();

console.log(iter.next().value); // "foo"
console.log(iter.next().value); // "bar"
console.log(iter.next().value); // "baz"

以下代码示例演示了如何使用 for...of 循环遍历注册表中的高亮部分。

js
const fooHighlight = new Highlight();
const barHighlight = new Highlight();
const bazHighlight = new Highlight();

CSS.highlights.set("foo", fooHighlight);
CSS.highlights.set("bar", barHighlight);
CSS.highlights.set("baz", bazHighlight);

for (const name of CSS.highlights.keys()) {
  console.log(name);
}

规范

规范
ECMAScript 语言规范
# sec-map.prototype.keys

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅