The addModule() method of the Worklet interface loads the module in the given JavaScript file and adds it to the current Worklet.
The addModule() method of the Worklet interface loads the module in the given JavaScript file and adds it to the current Worklet.
js
addModule(moduleURL) addModule(moduleURL, options)
moduleURL A String containing the URL of a JavaScript file with the module to add.
options Optional
An object with any of the following options:
credentials A Request.credentials value that indicates whether to send credentials (e.g. cookies and HTTP authentication) when loading the module. Can be one of "omit", "same-origin", or "include". Defaults to "same-origin". See also Request.credentials.
A Promise that resolves once the module from the given URL has been added. The promise doesn't return any value.
If addModule() fails, it rejects the promise, delivering one of the following errors to the rejection handler.
AbortError DOMException
The specified script is invalid or could not be loaded.
SyntaxError DOMException
The specified moduleURL is invalid.
js
const audioCtx = new AudioContext(); const audioWorklet = audioCtx.audioWorklet; audioWorklet.addModule("modules/bypassFilter.js", { credentials: "omit", });
js
CSS.paintWorklet.addModule( "https://mdn.github.io/houdini-examples/cssPaint/intro/worklets/hilite.js", );
Once the script has been added to the paint worklet, the CSS paint() function can be used to include the image created by the worklet:
css
@supports (background-image: paint(id)) { h1 { background-image: paint(hollowHighlights, filled, 3px); } }
| Specification |
|---|
| HTML Standard # dom-worklet-addmodule-dev |
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
addModule |
65 | 79 | 76 | No | 52 | 14.1 | 65 | 65 | 79 | 47 | 14.5 | 9.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Worklet/addModule