@webassemblyjs/wasm-gen

What is @webassemblyjs/wasm-gen?

The @webassemblyjs/wasm-gen package is a tool that allows for the generation of WebAssembly binary code. It is part of the WebAssembly.js project which aims to provide a set of tools to compile, decompile, validate, and manipulate WebAssembly modules. With wasm-gen, developers can programmatically create WebAssembly binaries using an Abstract Syntax Tree (AST) representation of the code.

What are @webassemblyjs/wasm-gen's main functionalities?

Generating WebAssembly binary

This feature allows the generation of WebAssembly binary code from an AST. The code sample demonstrates how to create a simple WebAssembly module with no imports, one function, and no exports, and then encode it into a binary format.

const { encode } = require('@webassemblyjs/wasm-gen');
const t = require('@webassemblyjs/ast');

const module = t.module(
  [],
  [
    t.func(t.indexLiteral(0), [], [], [])
  ],
  []
);

const binary = encode(module);
console.log(binary);

Other packages similar to @webassemblyjs/wasm-gen

wasm-opt

wasm-opt is a package that provides optimization tools for WebAssembly binaries. It is part of the Binaryen project and offers similar functionalities in terms of manipulating and optimizing WebAssembly code. Unlike @webassemblyjs/wasm-gen, which is focused on generation from AST, wasm-opt works directly on the binary and provides advanced optimization techniques.

wabt

The WebAssembly Binary Toolkit (wabt) is a suite of tools for WebAssembly, including a decoder, an interpreter, and a binary generator. It offers functionality similar to @webassemblyjs/wasm-gen but also includes additional tools for working with WebAssembly text format and running WebAssembly code. Wabt is more comprehensive, while @webassemblyjs/wasm-gen is more focused on generation from AST.

assemblyscript

AssemblyScript compiles a strict subset of TypeScript to WebAssembly. It provides a high-level approach to WebAssembly module generation, which is different from the low-level AST manipulation provided by @webassemblyjs/wasm-gen. AssemblyScript is suitable for developers familiar with TypeScript who want to write WebAssembly modules in a language they are comfortable with.

README

@webassemblyjs/wasm-gen

Emit documentation/code for your WASM binary

Installation

npm install -g @webassemblyjs/wasm-gen

Usage

wasmgen path/to/binary.wasm

Printers

Text (default):

wasmgen -o text path/to/binary.wasm

Markdown:

wasmgen -o md path/to/binary.wasm

// or

wasmgen -o markdown path/to/binary.wasm

JavaScript:

wasmgen -o js --url http://xtuc.fr/foo.wasm path/to/binary.wasm

// or

wasmgen -o javascript --url http://xtuc.fr/foo.wasm path/to/binary.wasm