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.

Diese Methode kann verwendet werden, um einen leicht modifizierten Sanitizer von der Standardkonfiguration zu erstellen; indem Sie zunächst die Standardkonfiguration abrufen, dann modifizieren und sie dann zum Erstellen eines neuen Sanitizers verwenden.

Die zurückgegebene Konfiguration kann auch zur Überprüfung der Konfiguration verwendet werden und kann direkt an die HTML-Parsing-Funktionen übergeben werden. Beachten Sie jedoch, dass es effizienter ist, einen Sanitizer zu übergeben, anstatt ein Konfigurationswörterbuch, 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 seine 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, falls ja, ein neues Sanitizer Objekt mit einer einfachen SanitizerConfig, die die HTML-Elemente: <div>, <p>, <span>, <script> zulässt. 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

Das Ergebnis wird unten protokolliert. Beachten Sie, dass die gleichen Elemente, die beim Erstellen des Sanitizers eingestellt wurden, zurückgegeben werden, die neuen Elemente jedoch auch einen Namensraum haben. Beachten Sie auch hier, dass Kommentare und Datenattribute zugelassen werden.

Abrufen des Standardsanitizers

Dieses Beispiel zeigt, wie Sie die Konfiguration für den Standard-Sanitizer abrufen 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. Dann erstellt er den Standard-Sanitizer, ohne Optionen zu übergeben, und ruft anschließend die Konfiguration ab und protokolliert sie.

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 groß ist und viele Elemente und Attribute zulässt.

Spezifikationen

Specification
HTML Sanitizer API # dom-sanitizer-get