Highlight: values() method

Limited availability

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

The values() method of the Highlight interface returns a new Iterator object that contains the values for each Range object in the Highlight object in insertion order.

Note: The keys() method is an alias for this method. It behaves exactly the same and returns values of Highlight elements.

Highlight is a Set-like object, so this is similar to using Set.values().

Syntax

js
values()

Return value

A new iterator object containing each Range object in the given Highlight, in insertion order.

Examples

The following code snippet shows how to create a new Highlight object with three Range objects, and use the iterator returned by the values() method to log the three ranges:

js
const myHighlight = new Highlight();
myHighlight.add(new Range());
myHighlight.add(new Range());
myHighlight.add(new Range());

const iter = myHighlight.values();

for (value of iter) {
  console.log(value); // Range
}

Specifications

Specification
ECMAScript® 2025 Language Specification
# sec-set.prototype.values

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
values

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
In development. Supported in a pre-release version.
In development. Supported in a pre-release version.
No support
No support
See implementation notes.

See also