Sanitizer: setComments() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The setComments() method of the Sanitizer interface sets whether comments will be allowed or removed by the sanitizer.
Syntax
js
setComments(allow);
Parameters
allow-
trueif comments are allowed, andfalseif 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.
js
// Create sanitizer (in this case the default)
const sanitizer = new Sanitizer();
// Allow comments
sanitizer.setComments(true);
// Remove comments
sanitizer.setComments(false);
Specifications
| Specification |
|---|
| HTML Sanitizer API # dom-sanitizer-setcomments |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
setComments
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support