Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
2019-09-26 09:49:43 -05:00
.cargo Start running CI tests on Rust beta 2018-09-25 10:36:28 -07:00
benchmarks Run fmt and clippy 2019-05-28 09:52:44 -05:00
ci Upgrade sccache to 0.2.11 2019-09-16 08:35:15 -07:00
crates Fix local webdriver discovery via PATH (#1794) 2019-09-26 09:49:43 -05:00
examples Add support for #[wasm_bindgen] on async fn (#1754) 2019-09-06 13:47:16 -05:00
guide Add ability to run tests on remote webdriver. (#1744) 2019-09-19 09:00:51 -05:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src Ensure that various Into/From ABI methods are inlined 2019-09-10 17:32:30 -07:00
tests Handle JSON.stringify(undefined) 2019-09-25 11:24:48 -05:00
_package.json chore: upgrade @wasm-tool/wasm-pack-plugin to 1.0.1 2019-08-27 18:20:24 +01:00
.gitattributes add .gitattributes to mark WebIDL as vendored 2018-07-11 18:48:51 -04:00
.gitignore Bump to 0.2.18 2018-08-27 13:37:55 -07:00
azure-pipelines.yml Switch CI to testing beta toolchains (#1792) 2019-09-25 12:45:49 -05:00
build.rs Implement AsRef<JsValue> for Closure<T> 2018-09-06 14:46:59 -07:00
Cargo.toml Fix codegen for descriptors of async fn returns (#1782) 2019-09-20 16:06:27 -05:00
CHANGELOG.md More CHANGELOG updates 2019-09-25 09:31:46 -07:00
CONTRIBUTING.md Fix contributing URL 2018-09-20 17:37:04 -07:00
LICENSE-APACHE Add license texts 2017-12-18 14:45:06 -08:00
LICENSE-MIT Add license texts 2017-12-18 14:45:06 -08:00
publish.rs rustfmt the publish script 2019-09-16 12:54:05 -07:00
README.md Fix README's badges 2019-05-23 14:27:16 -07:00

wasm-bindgen

Facilitating high-level interactions between Wasm modules and JavaScript.

Build Status Crates.io version Download docs.rs docs

Guide | API Docs | Contributing | Chat

Built with 🦀🕸 by The Rust and WebAssembly Working Group

Example

Import JavaScript things into Rust and export Rust things to JavaScript.

use wasm_bindgen::prelude::*;

// Import the `window.alert` function from the Web.
#[wasm_bindgen]
extern "C" {
    fn alert(s: &str);
}

// Export a `greet` function from Rust to JavaScript, that alerts a
// hello message.
#[wasm_bindgen]
pub fn greet(name: &str) {
    alert(&format!("Hello, {}!", name));
}

Use exported Rust things from JavaScript with ECMAScript modules!

import { greet } from "./hello_world";

greet("World!");

Features

  • Lightweight. Only pay for what you use. wasm-bindgen only generates bindings and glue for the JavaScript imports you actually use and Rust functionality that you export. For example, importing and using the document.querySelector method doesn't cause Node.prototype.appendChild or window.alert to be included in the bindings as well.

  • ECMAScript modules. Just import WebAssembly modules the same way you would import JavaScript modules. Future compatible with WebAssembly modules and ECMAScript modules integration.

  • Designed with the "Web IDL bindings" proposal in mind. Eventually, there won't be any JavaScript shims between Rust-generated wasm functions and native DOM methods. Because the wasm functions are statically type checked, some of those native methods' dynamic type checks should become unnecessary, promising to unlock even-faster-than-JavaScript DOM access.

Guide

📚 Read the wasm-bindgen guide here! 📚

You can find general documentation about using Rust and WebAssembly together here.

API Docs

License

This project is licensed under either of

at your option.

Contribution

See the "Contributing" section of the guide for information on hacking on wasm-bindgen!

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.