W3cubDocs

/JavaScript

WebAssembly.Module

A WebAssembly.Module object contains stateless WebAssembly code that has already been compiled by the browser — this can be efficiently shared with Workers, and instantiated multiple times.

Constructor

WebAssembly.Module()

Creates a new Module object.

Static properties

WebAssembly.Module.customSections()

Given a Module and string, returns a copy of the contents of all custom sections in the module with the given string name.

WebAssembly.Module.exports()

Given a Module, returns an array containing descriptions of all the declared exports.

WebAssembly.Module.imports()

Given a Module, returns an array containing descriptions of all the declared imports.

Examples

Sending a compiled module to a worker

The following example compiles the loaded simple.wasm byte code using the WebAssembly.compileStreaming() method and sends the resulting Module instance to a worker using postMessage().

See the index-compile.html source code or view it live.

const worker = new Worker("wasm_worker.js");

WebAssembly.compileStreaming(fetch('simple.wasm'))
  .then((mod) => worker.postMessage(mod));

The worker function wasm_worker.js defines an import object for the module to use. The function then sets up an event handler to receive the module from the main thread. When the module is received, we create an instance from it using the WebAssembly.instantiate() method and invoke an exported function from inside it.

const importObject = {
  imports: {
    imported_func(arg) {
      console.log(arg);
    }
  }
};

onmessage = (e) => {
  console.log('module received from main thread');
  const mod = e.data;

  WebAssembly.instantiate(mod, importObject).then((instance) => {
    instance.exports.exported_func();
  });
};

Specifications

Browser compatibility

Desktop Mobile Server
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet Deno Node.js
Module
57
16
52
No
44
11
57
57
52
43
11
7.0
1.0
8.0.0
Module
57
16
52
No
44
11
57
57
52
43
11
7.0
1.0
8.0.0
customSections
57
16
52
No
44
11
57
57
52
43
11
7.0
1.0
8.0.0
exports
57
16
52
No
44
11
57
57
52
43
11
7.0
1.0
8.0.0
imports
57
16
52
No
44
11
57
57
52
43
11
7.0
1.0
8.0.0

See also

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module