A template for kick starting a Rust and WebAssembly project using wasm-pack.

Built with 🦀🕸 by The Rust and WebAssembly Working Group

About

📚 Read this template tutorial! 📚

This template is designed for compiling Rust libraries into WebAssembly and publishing the resulting package to NPM.

Be sure to check out other wasm-pack tutorials online for other templates and usages of wasm-pack.

🚴 Usage

import wasm from '@rezarahemtola/wasm-test';

// Making sure we are on the browser (e.g. if using SSR)
if (typeof window !== 'undefined') {
	wasm.greet();
}

The webpack.config.js should be updated to enable async WebAssembly.
In my case using Next.js, I added the following lines to next.config.js:

webpack: (config) => {
  config.experiments = {
    asyncWebAssembly: true,
  }
  return config;
},

🐑 Use cargo generate to Clone this Template

Learn more about cargo generate here.

cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project
cd my-project

🛠️ Build with wasm-pack build

wasm-pack build

🔬 Test in Headless Browsers with wasm-pack test

wasm-pack test --headless --firefox

🎁 Publish to NPM with wasm-pack publish

wasm-pack publish

🔋 Batteries Included

• wasm-bindgen for communicating between WebAssembly and JavaScript.
• console_error_panic_hook for logging panic messages to the developer console.
• wee_alloc, an allocator optimized for small code size.
• LICENSE-APACHE and LICENSE-MIT: most Rust projects are licensed this way, so these are included for you