-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
90 lines (66 loc) · 2.2 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
title: "Worklet: addModule() method"
short-title: addModule()
slug: Web/API/Worklet/addModule
page-type: web-api-instance-method
browser-compat: api.Worklet.addModule
---
{{APIRef("Worklets")}}{{SecureContext_Header}}
The **`addModule()`** method of the
{{domxref("Worklet")}} interface loads the module in the given JavaScript file and
adds it to the current `Worklet`.
## Syntax
```js-nolint
addModule(moduleURL)
addModule(moduleURL, options)
```
### Parameters
- `moduleURL`
- : A {{jsxref("String")}} containing the URL of a JavaScript file with the module to
add.
- `options` {{optional_inline}}
- : An object with any of the following options:
- `credentials`
- : A {{domxref("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 {{domxref("Request.credentials")}}.
### Return value
A {{jsxref("Promise")}} that resolves once the module from the given URL has been
added. The promise doesn't return any value.
### Exceptions
If `addModule()` fails, it rejects the promise, delivering one of the
following errors to the rejection handler.
- `AbortError` {{domxref("DOMException")}}
- : The specified script is invalid or could not be loaded.
- `SyntaxError` {{domxref("DOMException")}}
- : The specified `moduleURL` is invalid.
## Examples
### AudioWorklet example
```js
const audioCtx = new AudioContext();
const audioWorklet = audioCtx.audioWorklet;
audioWorklet.addModule("modules/bypassFilter.js", {
credentials: "omit",
});
```
### PaintWorklet example
```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](/en-US/docs/Web/API/CSS/paintWorklet_static), the CSS {{cssxref("image/paint", "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);
}
}
```
## Specifications
{{Specifications}}
## Browser compatibility
{{Compat}}