Worklet: addModule()-Methode

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die addModule()-Methode der Worklet-Schnittstelle lädt das Modul in der angegebenen JavaScript-Datei und fügt es dem aktuellen Worklet hinzu.

Syntax

addModule(moduleURL)
addModule(moduleURL, options)

Parameter

moduleURL

Ein String, der die URL einer JavaScript-Datei mit dem hinzuzufügenden Modul enthält.

options Optional

Ein Objekt mit einer der folgenden Optionen:

credentials: Ein Request.credentials-Wert, der angibt, ob Anmeldedaten (z.B. Cookies und HTTP-Authentifizierung) beim Laden des Moduls gesendet werden sollen. Kann einer der folgenden Werte sein: "omit", "same-origin" oder "include". Standardmäßig auf "same-origin" gesetzt. Siehe auch Request.credentials.

Rückgabewert

Ein Promise, das aufgelöst wird, sobald das Modul von der angegebenen URL hinzugefügt wurde. Das Promise gibt keinen Wert zurück.

Ausnahmen

Falls addModule() fehlschlägt, lehnt es das Promise ab und übergibt einen der folgenden Fehler an den Ablehnungs-Handler.

AbortError DOMException: Das angegebene Skript ist ungültig oder konnte nicht geladen werden.
SyntaxError DOMException: Die angegebene moduleURL ist ungültig.

Beispiele

AudioWorklet-Beispiel

const audioCtx = new AudioContext();
const audioWorklet = audioCtx.audioWorklet;
audioWorklet.addModule("modules/bypassFilter.js", {
  credentials: "omit",
});

PaintWorklet-Beispiel

CSS.paintWorklet.addModule(
  "https://mdn.github.io/houdini-examples/cssPaint/intro/worklets/hilite.js",
);

Sobald das Skript zum paint worklet hinzugefügt wurde, kann die CSS-paint()-Funktion verwendet werden, um das vom Worklet erstellte Bild einzubinden:

css

@supports (background-image: paint(id)) {
  h1 {
    background-image: paint(hollowHighlights, filled, 3px);
  }
}

Spezifikationen

Specification
HTML Standard # dom-worklet-addmodule-dev

Browser-Kompatibilität

BCD tables only load in the browser