wasm-bindgen/guide/src/introduction.md

# 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 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://rustwasm.github.io/wasm-bindgen/contributing/design/index.html
[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
[hello-online]: https://webassembly.studio/?f=gzubao6tg3
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`. 2018-06-19 11:08:54 -07:00			`# 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].`
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`. 2018-09-20 16:20:42 -07:00			`* Exporting Rust functionality to JS such as classes, functions, etc.`
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`. 2018-06-19 11:08:54 -07:00			`* 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`
Update design doc link Closes #851 2018-09-20 17:38:19 -07:00			`[design doc]: https://rustwasm.github.io/wasm-bindgen/contributing/design/index.html`
guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`. 2018-06-19 11:08:54 -07:00			`[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`
			`[hello-online]: https://webassembly.studio/?f=gzubao6tg3`