Highlight: has() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The has() method of the Highlight interface returns a boolean indicating whether a Range object exists in a Highlight object or not.

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

Syntax

js

has(range)

Parameters

range

The Range object to test for presence in the Highlight object.

Return value

Returns true if the specified range exists in the Highlight object; otherwise false.

Examples

The code snippet below creates two ranges, and a highlight object that contains one of them. The code then uses the has() method to check whether each range exists in the highlight:

js

const range1 = new Range();
const range2 = new Range();
const myHighlight = new Highlight(range1);

myHighlight.has(range1); // true
myHighlight.has(range2); // false

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also