ruby.wasm

The @ruby/head-wasm-wasi package provides WebAssembly binaries of CRuby built from the latest HEAD source code. These binaries are specifically targeted for environments compatible with WASI Preview1.

To use this package, follow the same integration patterns as the @ruby/wasm-wasi package. For detailed usage instructions, refer to the @ruby/wasm-wasi documentation.

The @ruby/head-wasm-wasip2 package provides WebAssembly binaries of CRuby built from the latest HEAD source code. It is specifically designed for environments that are compatible with WASI Preview2.

To learn how to integrate and use this package in your project, refer to the @ruby/wasm-wasi documentation.

The defaultModule passed to loadRuby acts as a thin wrapper around the Emscripten Module object. You can use it to intercept and manage the execution environment. Common properties include:

• locateFile: A function (path) => string used to resolve the location of WebAssembly files.
• setStatus: A callback (msg) => void called by Emscripten to report status changes.
• print: A callback (line) => void used to handle output.
• arguments: An array of strings representing the command-line arguments passed to the Ruby process.

To use Ruby in a Node.js environment, install the @ruby/4.0-wasm-wasi and @ruby/wasm-wasi npm packages. You can then instantiate a Ruby VM by reading the .wasm binary, compiling it, and using DefaultRubyVM from @ruby/wasm-wasi/dist/node.

import fs from "fs/promises";
import { DefaultRubyVM } from "@ruby/wasm-wasi/dist/node";

const binary = await fs.readFile("./node_modules/@ruby/4.0-wasm-wasi/dist/ruby.wasm");
const module = await WebAssembly.compile(binary);
const { vm } = await DefaultRubyVM(module);
vm.eval(`puts "hello world"`);

For JavaScript host environments, you can install specific Ruby versions as npm packages. Available packages include:

• @ruby/4.0-wasm-wasi: CRuby 4.0 with WASI and JS interop.
• @ruby/3.4-wasm-wasi: CRuby 3.4 with WASI and JS interop.
• @ruby/3.3-wasm-wasi: CRuby 3.3 with WASI and JS interop.
• @ruby/3.2-wasm-wasi: CRuby 3.2 with WASI and JS interop.
• @ruby/head-wasm-wasi: HEAD CRuby with WASI and JS interop.
• @ruby/head-wasm-emscripten: HEAD CRuby built on Emscripten (not well tested).

The @ruby/4.0-wasm-wasi package provides WebAssembly binaries of CRuby built from the latest 4.0 source code. It is designed for environments compatible with WASI Preview1.

To use this package, refer to the @ruby/wasm-wasi documentation for general usage patterns and integration instructions.

This package provides WebAssembly binaries of CRuby built from the Ruby 3.2 source code, specifically targeting WASI-compatible environments.

To use this package, refer to the general @ruby/wasm-wasi documentation for implementation details and usage patterns.

To view the browser-based examples for the ruby-wasm-wasi package family, serve the directory using a local HTTP server and navigate to the provided HTML files.

1. Start a local server at port 8000 using Ruby's built-in HTTP server.
2. Open the following files in your browser:
   • http://localhost:8000/hello.html
   • http://localhost:8000/lucky.html
   • http://localhost:8000/ruby-box.html
   • http://localhost:8000/script-src

$ ruby -run -e httpd . -p 8000
$ # Open http://localhost:8000/hello.html
$ # Open http://localhost:8000/lucky.html
$ # Open http://localhost:8000/ruby-box.html
$ # Open http://localhost:8000/script-src

The @ruby/3.3-wasm-wasi package provides WebAssembly binaries of CRuby built from the Ruby 3.3 source code, specifically targeting WASI-compatible environments.

To learn how to integrate and use this package in your project, refer to the general @ruby/wasm-wasi documentation.