HighlightRegistry: set() method

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

The set() method of the HighlightRegistry interface adds or updates a Highlight object in the registry with the specified name.

HighlightRegistry is a Map-like object, so this is similar to using Map.set().

Syntax

js

set(name, highlight)

Parameters

name

The name of the Highlight object to add or update. The name must be a String.

highlight

The Highlight object to add or update. This must be a Highlight interface instance.

Return value

The HighlightRegistry object.

Examples

Using set()

js

const fooHighlight = new Highlight();
CSS.highlights.set("foo", fooHighlight);

Using set() with chaining

Since the set() method returns back the registry, you can chain the method call like below:

js

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

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

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also