Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
Alex Crichton efa4a2b8fa
Speed up Travis by running Webpack in fewer tests (#381)
* Reorganize Travis configuration

* Add a `JOB` env var descriptor to all matrix entries. Not used anywhere but is
  useful when viewing the whole build on Travis's web interface.
* Reorganize where builds are located, moving slow builds first and fast ones
  last.
* Change checking the CLI builds from `cargo build` to `cargo check`
* Use YAML references to reduce some duplication

* Print some more timing statistics for each test

* Extract `Project` helper in tests to a module

This'll help make it a bit more extensible over time. At the same time the
methods are also slightly reorganized to read more clearly from top to bottom.

* Migrate all tests away from Webpack

Wepback can take a significant amount of time to execute and when it's
multiplied by hundreds of tests that adds up really quickly! After investigating
Node's `--experimental-modules` option it looks like it's suitable for our use
so this switches all tests to using JS files (moving away from TypeScript as
well) with `--experimental-modules` with Node.

Tests will be selectively re-enabled with webpack and node.js specific output
(that doesn't require `--experimental-modules`), coming in later commits.

* Restore the node test for node.js output

Ensures it's workable as-is

* Only generate typescript with webpack

* Only read wasm files for webpack

* Skip package.json/node_modules for now

* Only generate webpack config if needed

* Start a dedicated test module for typescript

Will hopefully verify the generated Typescript compiles OK.

* Remove unneeded `node` method

* Fixup some rebase conflicts

* Don't run asmjs example on travis

* Fixup generator tests

* Attempt to fix windows

* Comment windows fix

* More test fixes

* More exclusions

* More test fixes

* Relax eslint regex

Catch mjs modules as well

* Fix eslint

* Speed up travis on examples slightly
2018-07-04 22:37:09 -05:00
crates Speed up Travis by running Webpack in fewer tests (#381) 2018-07-04 22:37:09 -05:00
examples Fix the constructor explanation in the guide (#372) 2018-07-03 09:24:43 -05:00
guide Fix typo in rust-type-conversions.md. (#390) 2018-07-04 13:53:20 -05:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src feat(js) Add ArrayBuffer::new, ::is_view & ::slice bindings. (#388) 2018-07-04 13:53:49 -05:00
tests/all Speed up Travis by running Webpack in fewer tests (#381) 2018-07-04 22:37:09 -05:00
.appveyor.yml use both npm and yarn in ci 2018-06-25 17:22:51 -07:00
.eslintrc.js Speed up Travis by running Webpack in fewer tests (#381) 2018-07-04 22:37:09 -05:00
.gitignore Binding for Math.cos,cosh,exp,expml,fround,imul,log,log10,log1p,log2 2018-06-28 12:46:53 -04:00
.travis.yml Speed up Travis by running Webpack in fewer tests (#381) 2018-07-04 22:37:09 -05: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 Speed up Travis by running Webpack in fewer tests (#381) 2018-07-04 22:37:09 -05:00
package.json Speed up Travis by running Webpack in fewer tests (#381) 2018-07-04 22:37:09 -05:00
README.md Point to the guide's contributing section instead of CONTRIBUTING.md 2018-06-19 12:05:52 -07:00
yarn.lock use both npm and yarn in ci 2018-06-25 17:22:51 -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.