WebAssembly

Guides

The WebAssembly guides cover topics such as high-level concepts, compiling from different languages, the textual representation of the Wasm binary format, and how to run WebAssembly.

WebAssembly concepts

Get started by reading the high-level concepts behind WebAssembly — what it is, why it is so useful, how it fits into the web platform (and beyond), and how to use it.

Compiling a new C/C++ module to WebAssembly

When you've written code in C/C++, you can then compile it into Wasm using a tool like Emscripten. Let's look at how it works.

Compiling an existing C module to WebAssembly

A core use-case for WebAssembly is to take the existing ecosystem of C libraries and allow developers to use them on the web.

Compiling from Rust to WebAssembly

If you've written some Rust code, you can compile it into WebAssembly! This tutorial takes you through all you need to know to compile a Rust project to Wasm and use it in an existing web app.

Loading and running WebAssembly code

After you have a Wasm module, this article covers how to fetch, compile and instantiate it, combining the WebAssembly JavaScript API with the Fetch or XHR APIs.

Using the WebAssembly JavaScript API

Once you've loaded a Wasm module, you'll want to use it. In this article, we show you how to use WebAssembly via the WebAssembly JavaScript API.

Exported WebAssembly functions

Exported WebAssembly functions are the JavaScript reflections of WebAssembly functions, which allow calling WebAssembly code from JavaScript. This article describes what they are.

Understanding WebAssembly text format

This article explains the Wasm text format. This is the low-level textual representation of a Wasm module shown in browser developer tools when debugging.

Converting WebAssembly text format to Wasm

This article provides a guide on how to convert a WebAssembly module written in text format into a Wasm binary.

API reference

WebAssembly instruction reference

Reference documentation with interactive samples for the set of WebAssembly operators.

WebAssembly JavaScript interface

This object acts as the namespace for all WebAssembly-related functionality.

WebAssembly.Global()

A WebAssembly.Global object represents a global variable instance, accessible from both JavaScript and importable/exportable across one or more WebAssembly.Module instances. This allows dynamic linking of multiple modules.

WebAssembly.Module()

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

WebAssembly.Instance()

A WebAssembly.Instance object is a stateful, executable instance of a Module. Instance objects contain all the Exported WebAssembly functions that allow calling into WebAssembly code from JavaScript.

WebAssembly.compile()

The WebAssembly.compile() function compiles WebAssembly binary code into a WebAssembly.Module object.

WebAssembly.compileStreaming()

The WebAssembly.compileStreaming() function compiles a WebAssembly.Module directly from a streamed underlying source.

WebAssembly.instantiate()

The WebAssembly.instantiate() function allows you to compile and instantiate WebAssembly code.

WebAssembly.instantiateStreaming()

The WebAssembly.instantiateStreaming() function is the primary API for compiling and instantiating WebAssembly code, returning both a Module and its first Instance.

WebAssembly.validate()

The WebAssembly.validate() function validates a given typed array of WebAssembly binary code.

WebAssembly.Memory()

A WebAssembly.Memory object is a resizable ArrayBuffer that holds the raw bytes of memory accessed by an Instance.

WebAssembly.Table()

A WebAssembly.Table object is a resizable typed array of opaque values, like function references, that are accessed by an Instance.

WebAssembly.Tag()

The WebAssembly.Tag object defines a type of WebAssembly exception that can be thrown to/from WebAssembly code.

WebAssembly.Exception()

The WebAssembly.Exception object represents a runtime exception thrown from WebAssembly to JavaScript, or thrown from JavaScript to a WebAssembly exception handler.

WebAssembly.CompileError()

Creates a new WebAssembly CompileError object.

WebAssembly.LinkError()

Creates a new WebAssembly LinkError object.

WebAssembly.RuntimeError()

Creates a new WebAssembly RuntimeError object.

Example projects

• WASMSobel
• See our webassembly-examples repo for a number of other examples.

Specifications

Browser compatibility

webassembly.api