WebAssembly.Module.customSections()

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.

Die statische Methode WebAssembly.Module.customSections() gibt eine Kopie des Inhalts aller benutzerdefinierten Abschnitte im gegebenen Modul mit dem angegebenen String-Namen zurück.

Syntax

js
WebAssembly.Module.customSections(module, sectionName)

Parameter

module

Das WebAssembly.Module Objekt, dessen benutzerdefinierte Abschnitte in Betracht gezogen werden.

sectionName

Der String-Name des gewünschten benutzerdefinierten Abschnitts.

Rückgabewert

Ein (möglicherweise leeres) Array, das ArrayBuffer-Kopien der Inhalte aller benutzerdefinierten Abschnitte enthält, die mit sectionName übereinstimmen.

Ausnahmen

Wenn module keine Instanz eines WebAssembly.Module Objekts ist, wird ein TypeError ausgelöst.

Beschreibung

Ein Wasm-Modul besteht aus einer Sequenz von Abschnitten. Die meisten dieser Abschnitte sind vollständig durch die Wasm-Spezifikation definiert und validiert, aber Module können auch benutzerdefinierte Abschnitte enthalten, die während der Validierung ignoriert und übersprungen werden. (Lesen Sie High level structure für Informationen über die Abschnittsstrukturen und wie normale Abschnitte ("bekannte Abschnitte") und benutzerdefinierte Abschnitte unterschieden werden.)

Dies bietet Entwicklern eine Möglichkeit, benutzerdefinierte Daten in Wasm-Modulen für andere Zwecke einzuschließen, zum Beispiel den name custom section, der es Entwicklern ermöglicht, Namen für alle Funktionen und lokalen Variablen im Modul bereitzustellen (ähnlich wie "Symbole" in einem nativen Build).

Beachten Sie, dass das WebAssembly-Textformat derzeit keine definierte Syntax zum Hinzufügen neuer benutzerdefinierter Abschnitte hat; Sie können jedoch während der Konvertierung vom Textformat nach Wasm einen Namensabschnitt zu Ihrem Wasm hinzufügen. Der Befehl wast2wasm, der Teil des wabt-Tools ist, hat eine --debug-names Option — geben Sie diese während der Konvertierung an, um ein Wasm mit einem benannten benutzerdefinierten Abschnitt zu erhalten, zum Beispiel:

bash
wast2wasm simple-name-section.was -o simple-name-section.wasm --debug-names

Beispiele

Verwendung von customSections

Das folgende Beispiel verwendet WebAssembly.Module.customSections, um zu überprüfen, ob eine geladene Modulinstanz einen "name" benutzerdefinierten Abschnitt enthält. Ein Modul enthält einen "name" benutzerdefinierten Abschnitt, wenn WebAssembly.Module.customSections einen ArrayBuffer mit einer Länge größer als 0 zurückgibt.

Siehe den Quellcode von custom-section.html source code und das live example.

js
WebAssembly.compileStreaming(fetch("simple-name-section.wasm")).then((mod) => { const nameSections = WebAssembly.Module.customSections(mod, "name"); if (nameSections.length !== 0) { console.log("Module contains a name section"); console.log(nameSections[0]); } });

Spezifikationen

Specification
WebAssembly JavaScript Interface
# dom-module-customsections

Browser-Kompatibilität

Siehe auch