Sanitizer: setComments() method

{{APIRef("HTML Sanitizer API")}}

The setComments() method of the {{domxref("Sanitizer")}} interface sets whether comments will be allowed or removed by the sanitizer.

Syntax

setComments(allow);

Parameters

• allow
  • : true if comments are allowed, and false if they are to be removed.

Return value

true if the operation changed the configuration, and false if the configuration already set comments to the specified value.

Examples

How to sanitize comments

The code below shows the basic usage of the setComments() method.

// Create sanitizer (in this case the default)
const sanitizer = new Sanitizer();

// Allow comments
sanitizer.setComments(true);

// Remove comments
sanitizer.setComments(false);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}