Sanitizer: `get()`-Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die get()-Methode der Sanitizer-Schnittstelle gibt eine SanitizerConfig-Wörterbuchinstanz zurück, die die aktuelle Sanitizer-Konfiguration darstellt.

Dies kann verwendet werden, um einen leicht modifizierten Desinfizierer vom Standard zu erstellen; indem zuerst die Standard-Sanitizer-Konfiguration abgerufen und dann modifiziert wird, um einen neuen Sanitizer zu konstruieren.

Die zurückgegebene Konfiguration kann auch zur Inspektion der Konfiguration verwendet werden und kann direkt an die HTML-Parsing-Funktionen übergeben werden. Beachten Sie jedoch, dass es effizienter ist, einen Sanitizer anstelle eines Konfigurationswörterbuchs zu übergeben, insbesondere wenn der Sanitizer mehrfach verwendet werden soll.

Syntax

get()

Parameter

Keine

Rückgabewert

Ein SanitizerConfig.

Beispiele

Abrufen einer Konfiguration

Dieses Beispiel zeigt, wie Sie einen neuen Sanitizer erstellen und dessen Konfiguration abrufen können.

<pre id="log"></pre>

#log {
  height: 400px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}

const logElement = document.querySelector("#log");
function log(text) {
  logElement.textContent = text;
}

JavaScript

Der folgende Code testet, ob die Sanitizer-Schnittstelle unterstützt wird, und erstellt gegebenenfalls ein neues Sanitizer-Objekt mit einer einfachen SanitizerConfig, die die HTML-Elemente zulässt: <div>, <p>, <span>, <script>. Anschließend wird die Konfiguration abgerufen und protokolliert.

if ("Sanitizer" in window) {

// Create sanitizer using SanitizerConfig
const sanitizer = new Sanitizer({ elements: ["div", "p", "span", "script"] });

// Get current configuration
const sanitizerConfig = sanitizer.get();

log(JSON.stringify(sanitizerConfig, null, 2));

} else {
  log("The HTML Sanitizer API is NOT supported in this browser.");
}

Ergebnisse

Die Ausgabe wird unten protokolliert. Beachten Sie, dass dieselben Elemente, die beim Konstruieren des Sanitizers gesetzt wurden, zurückgegeben werden, aber die neuen Elemente auch einen Namespace haben. Beachten Sie auch, dass Kommentare und Datenattribute zugelassen werden.

Abrufen des Standard-Sanitizers

Dieses Beispiel zeigt, wie Sie die Konfiguration für den Standard-Sanitizer erhalten können. Diese kann dann modifiziert und verwendet werden, um einen neuen Sanitizer zu erstellen, der Ihren spezifischen Anforderungen entspricht.

<pre id="log"></pre>

#log {
  height: 400px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}

JavaScript

Der folgende Code testet, ob die Sanitizer-Schnittstelle unterstützt wird. Es wird dann der Standard-Sanitizer erstellt, indem keine Optionen übergeben werden, und anschließend wird die Konfiguration abgerufen und protokolliert.

const logElement = document.querySelector("#log");
function log(text) {
  logElement.textContent = text;
}

if ("Sanitizer" in window) {

// Create default sanitizer
const sanitizer = new Sanitizer();

// Get default configuration
const defaultConfig = sanitizer.get();

log(JSON.stringify(defaultConfig, null, 2));

} else {
  log("The HTML Sanitizer API is NOT supported in this browser.");
}

Ergebnisse

Die Standard-Sanitizer-Konfiguration wird unten protokolliert. Beachten Sie, dass die Standardkonfiguration ziemlich umfangreich ist und viele Elemente und Attribute zulässt.

Spezifikationen

Specification
HTML Sanitizer API # dom-sanitizer-get