Worklet.addModule

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

Syntax

Promise<void> worklet.addModule(moduleURL);
Promise<void> 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 "omit". See also Request.credentials.

Return value

A Promise that resolves to undefined once the module from the given URL has been added.

Examples

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

Specifications

Browser compatibility

No compatibility data found. Please contribute data for "api.Worklet.addModule" (depth: 1) to the MDN compatibility data repository.