Worklet.addModule()

これは実験的な機能です。本番で使用する前にブラウザー実装状況をチェックしてください。

Worklet インタフェースで定義される addModule() メソッドを利用することで、指定したJavaScript ファイルで定義されるモジュールを Worklet にロードできます。

記法

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

パラメータ

moduleURL
追加するモジュールが定義されている JavaScript ファイルのURLを表す String
options Optional
次のオプションを指定するためのオブジェクト:
  • credentials: RequestCredentials に指定するモジュールのロードに必要な クレデンシャル情報 (例: cookies や HTTP 認証)。 "omit""same-origin""include"のいずれかの値を指定します。デフォルト値は"same-origin"となっています。詳しくは Request.credentials を参照してください。

返り値

Promise オブジェクトが帰ります。このオブジェクトは、URLで指定されたモジュールがロードできた場合に受理状態になります。またコールバック関数は何の引数も与えられず呼び出されます。

使用例

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

仕様

仕様 状況 コメント
Worklets Level 1
addModule() の定義
草案  

ブラウザ互換性

BCD tables only load in the browser