Worklet.addModule()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The addModule() method of the Worklet interface loads the module in the given JavaScript file and adds it to the current Worklet.

Syntax

addPromise = worklet.addModule(moduleURL);
addPromise = worklet.addModule(moduleURL, options);

Parameters

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 RequestCredentials value that indicates whether to send credentials (e.g. cookies and HTTP authentification) when loading the module. Can be one of "omit", "same-origin", or "include". Defaults to "same-origin". See also Request.credentials.

Return value

A Promise that resolves once the module from the given URL has been added. The promise doesn't return any value.

Examples

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

Specifications

Specification Status Comment
Worklets Level 1
The definition of 'addModule()' in that specification.
Working Draft  

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 65Edge No support NoFirefox Full support 63IE No support NoOpera Full support 52Safari No support NoWebView Android Full support 65Chrome Android Full support 65Edge Mobile No support NoFirefox Android Full support 63Opera Android Full support 52Safari iOS No support NoSamsung Internet Android Full support Yes

Legend

Full support  
Full support
No support  
No support
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.

Document Tags and Contributors

Contributors to this page: chrisdavidmills, Sheppy, Jedipedia
Last updated by: chrisdavidmills,