Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
Nick Fitzgerald ee4fb86400 ci: Don't run before_deploy unless DEPLOY=1
The before_deploy commands are for when we are building release tarballs, and we
don't want to do that for when we are deploying the guide to gh-pages.
2018-06-19 13:47:44 -07:00
crates Merge pull request #274 from fitzgen/js-sys 2018-06-19 10:42:04 -07:00
examples Copy doc comments from Rust to JS (#265) 2018-06-15 09:20:56 -07:00
guide guide: Add a contributing section and move DESIGN.md under it 2018-06-19 12:05:52 -07:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src Expose objects and functions from the JavaScript global scope 2018-06-18 16:41:01 -07:00
tests/all Merge pull request #274 from fitzgen/js-sys 2018-06-19 10:42:04 -07:00
.appveyor.yml Fix tests by pinning versions of webpack (#219) 2018-06-01 13:42:59 -05:00
.eslintrc.js Update js formatting 2018-06-15 12:55:37 -05:00
.gitignore Update gitignore to ignore typescript files 2018-04-27 13:25:53 -07:00
.travis.yml ci: Don't run before_deploy unless DEPLOY=1 2018-06-19 13:47:44 -07:00
Cargo.toml Expose objects and functions from the JavaScript global scope 2018-06-18 16:41:01 -07:00
CHANGELOG.md Add a change log 2018-06-19 12:05:52 -07:00
CONTRIBUTING.md Point to the guide's contributing section instead of CONTRIBUTING.md 2018-06-19 12:05:52 -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
package-lock.json Update js formatting 2018-06-15 12:55:37 -05:00
package.json Update js formatting 2018-06-15 12:55:37 -05:00
README.md Point to the guide's contributing section instead of CONTRIBUTING.md 2018-06-19 12:05:52 -07:00

wasm-bindgen

Facilitating high-level interactions between wasm modules and JavaScript.

Introduction blog post: "JavaScript to Rust and Back Again: A wasm-bindgen Tale"

Build Status Build status API Documentation on docs.rs

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

src/lib.rs:

#![feature(proc_macro, wasm_custom_section, wasm_import_module)]

extern crate wasm_bindgen;
use wasm_bindgen::prelude::*;

// Import the `window.alert` function from the Web.
#[wasm_bindgen]
extern {
    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!

index.js:

// Asynchronously load, compile, and import the Rust's WebAssembly
// and JavaScript interface.
import("./hello_world").then(module => {
  // Alert "Hello, World!"
  module.greet("World!");
});

Guide

📚 Read the wasm-bindgen guide here! 📚

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.