fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-07-31 03:51:56 +00:00
Code Issues Projects Releases Wiki Activity

Tweak introductory and deployment documentation.

Browse Source 
This commit rejiggers some documentation of `wasm-bindgen` in a few
significant ways:

* The main landing page now has text and links to the Game of Life
  tutorial and `wasm-pack`.
* The "whirlwind tour" was deleted as it wasn't really serving any
  purpose that the Game of Life plus the later references weren't already
  serving.
* The "no modules" example was renamed to "without a bundler"
* A dedicated section on "Deployment" was added which replaces the
  previous "No ES Modules" page. This is hopefully more descriptive and
  also prominently mentions the various options for deployment.
This commit is contained in:
Alex Crichton
2019-02-21 11:49:08 -08:00
parent 74a39ce618
commit b71f3374c5
18 changed files with 189 additions and 532 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
examples/no_modules/index.html
View File

@@ -1,20 +0,0 @@
<html>
<head>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type"/>
</head>
<body>
<!-- this is the JS generated by the `wasm-bindgen` CLI tool -->
<script src='./pkg/no_modules.js'></script>
<script>
window.addEventListener('load', async () => {
// the `wasm_bindgen` global is set to the exports of the Rust module
//
// here we tell bindgen the path to the wasm file so it can run
// initialization and return to us a promise when it's done
// also, we can use 'await' on the returned promise
await wasm_bindgen('./pkg/no_modules_bg.wasm');
});
</script>
</body>
</html>

2
examples/no_modules/Cargo.toml → examples/without-a-bundler/Cargo.toml
View File

@@ -1,5 +1,5 @@
[package]
name = "no_modules"
name = "without-a-bundler"
version = "0.1.0"
authors = ["The wasm-bindgen Developers"]
edition = "2018"

4
examples/no_modules/README.md → examples/without-a-bundler/README.md
View File

@@ -1,8 +1,8 @@
# Using `--no-modules`
# Without a Bundler
[View documentation for this example online][dox]
[dox]: https://rustwasm.github.io/wasm-bindgen/examples/no-modules.html
[dox]: https://rustwasm.github.io/wasm-bindgen/examples/without-a-bundler.html
You can build the example locally with:

44
examples/without-a-bundler/index.html Normal file
View File

@@ -0,0 +1,44 @@
<html>
<head>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type"/>
</head>
<body>
<!--
This is the JS generated by the `wasm-pack` build command
The script here will define a `wasm_bindgen` global where all
functionality can be accessed such as instantiation and the actual
functions (examples below).
You can customize the name of the file here with the `out-name` CLI flag
to `wasm-bindgen`. You can also customize the name of the global exported
here with the `no-modules-global` flag.
-->
<script src='./pkg/without_a_bundler.js'></script>
<script>
// Import functionality from the wasm module, but note that it's not quite
// ready to be used just yet.
const { add } = wasm_bindgen;
async function run() {
// First up we need to actually load the wasm file, so we use the
// exported global to inform it where the wasm file is located on the
// server, and then we wait on the returned promies to wait for the
// wasm to be loaded.
//
// Note that instead of a string here you can also pass in an instance
// of `WebAssembly.Module` which allows you to compile your own module.
await wasm_bindgen('./pkg/without_a_bundler_bg.wasm');
// And afterwards we can use all the functionality defined in wasm.
const result = add(1, 2);
console.log(`1 + 2 = ${result}`);
if (result !== 3)
throw new Error("wasm addition doesn't work!");
}
run();
</script>
</body>
</html>

7
examples/no_modules/src/lib.rs → examples/without-a-bundler/src/lib.rs
View File

@@ -1,6 +1,6 @@
use wasm_bindgen::prelude::*;
// Called by our JS entry point to run the example
// Called when the wasm module is instantiated
#[wasm_bindgen(start)]
pub fn main() -> Result<(), JsValue> {
// Use `web_sys`'s global `window` function to get a handle on the global
@@ -17,3 +17,8 @@ pub fn main() -> Result<(), JsValue> {
Ok(())
}
#[wasm_bindgen]
pub fn add(a: u32, b: u32) -> u32 {
a + b
}