Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
dependabot-preview[bot] e0151898b7
Update assert_cmd requirement from 0.11 to 1.0 (#2188)
Updates the requirements on [assert_cmd](https://github.com/assert-rs/assert_cmd) to permit the latest version.
- [Release notes](https://github.com/assert-rs/assert_cmd/releases)
- [Changelog](https://github.com/assert-rs/assert_cmd/blob/master/CHANGELOG.md)
- [Commits](https://github.com/assert-rs/assert_cmd/compare/v0.11.0...v1.0.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-06-05 09:25:47 -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 address pr comments 2020-06-03 22:31:05 +02:00
crates Update assert_cmd requirement from 0.11 to 1.0 (#2188) 2020-06-05 09:25:47 -05:00
examples Merge pull request #2186 from rustwasm/dependabot/cargo/humantime-2 2020-06-05 09:25:24 -05:00
guide Merge pull request #2176 from jakobhellermann/deno-target 2020-06-03 16:20:30 -05:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src Mass rename anyref to externref (#2142) 2020-05-18 09:36:30 -05:00
tests Fix codegen of consuming setters/getters (#2172) 2020-05-29 15:28:52 -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 Add an unsafe method view_mut_raw (#1850) 2019-11-06 12:37:26 -06:00
azure-pipelines.yml Merge pull request #2176 from jakobhellermann/deno-target 2020-06-03 16:20:30 -05:00
build.rs Implement AsRef<JsValue> for Closure<T> 2018-09-06 14:46:59 -07:00
Cargo.toml address pr comments 2020-06-03 22:31:05 +02:00
CHANGELOG.md Bump to 0.2.63 (#2163) 2020-05-27 10:07:18 -05:00
CONTRIBUTING.md fix contributing docs url (#2043) 2020-03-17 09:09:46 -05: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 Mass rename anyref to externref (#2142) 2020-05-18 09:36:30 -05:00
README.md fix contributing docs url (#2043) 2020-03-17 09:09:46 -05: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.