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

guide: Add the wasm-bindgen guide

Browse Source 
Essentially split up the monolithic README.md into an `mdbook`.
This commit is contained in:
Nick Fitzgerald
2018-06-19 11:08:54 -07:00
parent e639a3f08f
commit 7c9973d9d1
10 changed files with 560 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
guide/src/introduction.md Normal file
View File

@ -0,0 +1,36 @@
# Introduction
`wasm-bindgen` facilitates high-level interactions between wasm modules and
JavaScript.
This project is sort of half polyfill for features like the [host bindings
proposal][host] and half features for empowering high-level interactions between
JS and wasm-compiled code (currently mostly from Rust). More specifically this
project allows JS/wasm to communicate with strings, JS objects, classes, etc, as
opposed to purely integers and floats. Using `wasm-bindgen` for example you can
define a JS class in Rust or take a string from JS or return one. The
functionality is growing as well!
Currently this tool is Rust-focused but the underlying foundation is
language-independent, and it's hoping that over time as this tool stabilizes
that it can be used for languages like C/C++!
Notable features of this project includes:
* Importing JS functionality in to Rust such as [DOM manipulation][dom-ex],
[console logging][console-log], or [performance monitoring][perf-ex].
* [Exporting Rust functionality][smorg-ex] to JS such as classes, functions, etc.
* Working with rich types like strings, numbers, classes, closures, and objects
rather than simply `u32` and floats.
This project is still relatively new but feedback is of course always
welcome! If you're curious about the design plus even more information about
what this crate can do, check out the [design doc].
[host]: https://github.com/WebAssembly/host-bindings
[design doc]: https://github.com/rustwasm/wasm-bindgen/blob/master/DESIGN.md
[dom-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/dom
[console-log]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/console_log
[perf-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/performance
[smorg-ex]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples/smorgasboard
[hello-online]: https://webassembly.studio/?f=gzubao6tg3