Highlight: entries() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Die entries() Methode der Highlight-Schnittstelle gibt ein neues Iterator-Objekt zurück, das ein Array von [range, range] für jedes Range-Objekt im Highlight-Objekt in Einfügereihenfolge enthält.

Highlight ist ein Set-ähnliches Objekt, daher ist dies ähnlich der Verwendung von Set.entries().

Syntax

js
entries()

Rückgabewert

Ein neues Iterator-Objekt, das ein Array von [range, range] für jedes Range-Objekt im gegebenen Highlight in Einfügereihenfolge enthält.

Beispiele

Der folgende Codeausschnitt zeigt, wie man ein neues Highlight mit zwei Bereichen erstellt und dann die Bereiche mithilfe des von der entries()-Methode zurückgegebenen Iterators protokolliert:

js
const text = new Text("Time is an illusion. Lunchtime doubly so.");

const range1 = document.createRange();
range1.setStart(text, 0);
range1.setEnd(text, 4);

const range2 = document.createRange();
range2.setStart(text, 21);
range2.setEnd(text, 30);

const myHighlight = new Highlight();
myHighlight.add(range1);
myHighlight.add(range2);

const iter = myHighlight.entries();

console.log(iter.next().value); // [Range, Range]
console.log(iter.next().value); // [Range, Range]

Das folgende Codebeispiel zeigt, wie man über die Bereiche in einem Highlight mit einer for...of-Schleife iteriert:

js
const text = new Text("Time is an illusion. Lunchtime doubly so.");

const range1 = document.createRange();
range1.setStart(text, 0);
range1.setEnd(text, 4);

const range2 = document.createRange();
range2.setStart(text, 21);
range2.setEnd(text, 30);

const highlight = new Highlight();
highlight.add(range1);
highlight.add(range2);

for (const [range] of highlight.entries()) {
  console.log(range.toString());
  // Time
  // Lunchtime
}

Spezifikationen

Specification
ECMAScript Language Specification
# sec-set.prototype.entries

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch