WebAssembly.instantiateStreaming()

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since October 2017.

* Some parts of this feature may have varying levels of support.

Die statische Methode WebAssembly.instantiateStreaming() kompiliert und instanziiert ein WebAssembly-Modul direkt aus einer gestreamten zugrunde liegenden Quelle. Dies ist die effizienteste und optimierte Art, Wasm-Code zu laden.

Hinweis: Webseiten mit einer strikten Content Security Policy (CSP) könnten verhindern, dass WebAssembly Module kompiliert und ausgeführt werden. Weitere Informationen zum Erlauben der WebAssembly-Kompilierung und -Ausführung finden Sie im Abschnitt script-src CSP.

Syntax

js
WebAssembly.instantiateStreaming(source) WebAssembly.instantiateStreaming(source, importObject) WebAssembly.instantiateStreaming(source, importObject, compileOptions) 

Parameter

source

Ein Response-Objekt oder ein Versprechen, das mit einem erfüllt wird und die zugrunde liegende Quelle eines Wasm-Moduls repräsentiert, das Sie streamen, kompilieren und instanziieren möchten.

importObjectOptional

Ein Objekt, das die Werte enthält, die in die neu erstellte Instance importiert werden sollen, wie Funktionen oder WebAssembly.Memory-Objekte. Es muss für jeden deklarierten Import des kompilierten Moduls eine übereinstimmende Eigenschaft vorhanden sein, andernfalls wird ein WebAssembly.LinkError ausgelöst.

compileOptionsOptional

Ein Objekt, das Kompilierungsoptionen enthält. Eigenschaften können umfassen:

builtinsOptional

Ein Array von Strings, das die Nutzung von JavaScript builtins im kompilierten Wasm-Modul ermöglicht. Die Strings definieren die builtins, die Sie aktivieren möchten. Derzeit ist der einzige verfügbare Wert "js-string", der JavaScript-String-Builtins aktiviert.

importedStringConstantsOptional

Ein String, der einen Namensraum für importierte globale String-Konstanten spezifiziert. Diese Eigenschaft muss angegeben werden, wenn Sie importierte globale String-Konstanten im Wasm-Modul verwenden möchten.

Rückgabewert

Ein Promise, das sich in ein ResultObject auflöst, welches zwei Felder enthält:

Ausnahmen

Beispiele

Streaming-Instanziierung

Das folgende Beispiel (siehe unser instantiate-streaming.html Demo auf GitHub, und sehen Sie es live) streamt ein Wasm-Modul direkt aus einer zugrunde liegenden Quelle, kompiliert und instanziiert es dann, wobei das Versprechen mit einem ResultObject erfüllt wird. Da die Funktion instantiateStreaming() ein Promise für ein Response-Objekt akzeptiert, können Sie ihr direkt einen fetch()-Aufruf übergeben, und es wird die Antwort in die Funktion übergeben, wenn sie erfüllt wird.

js
const importObject = { my_namespace: { imported_func: (arg) => console.log(arg) }, }; WebAssembly.instantiateStreaming(fetch("simple.wasm"), importObject).then( (obj) => obj.instance.exports.exported_func(), ); 

Das ResultObject-Instanzmitglied wird dann aufgerufen, und die enthaltene exportierte Funktion aufgerufen.

Hinweis: Damit dies funktioniert, sollten .wasm-Dateien vom Server mit einem application/wasm MIME-Typ zurückgegeben werden.

Aktivierung von JavaScript builtins und globalen String-Importen

Dieses Beispiel aktiviert JavaScript-String-Builtins und importierte globale String-Konstanten beim Kompilieren und Instanziieren des Wasm-Moduls mit instantiateStreaming(), bevor die exportierte main()-Funktion ausgeführt wird (die "hello world!" in die Konsole loggt). Sehen Sie es live.

js
const importObject = { // Regular import m: { log: console.log, }, }; const compileOptions = { builtins: ["js-string"], // Enable JavaScript string builtins importedStringConstants: "string_constants", // Enable imported global string constants }; WebAssembly.instantiateStreaming( fetch("log-concat.wasm"), importObject, compileOptions, ).then((result) => result.instance.exports.main()); 

Spezifikationen

Specification
WebAssembly Web API
# dom-webassembly-instantiatestreaming

Browser-Kompatibilität

Siehe auch