wasm-bindgen/crates/futures/README.md

# `wasm-bindgen-futures`

[API Documention][docs]

This crate bridges the gap between a Rust `Future` and a JavaScript
`Promise`. It provides two conversions:

1. From a JavaScript `Promise` into a Rust `Future`.
2. From a Rust `Future` into a JavaScript `Promise`.

See the [API documentation][docs] for more info.

[docs]: https://rustwasm.github.io/wasm-bindgen/api/wasm_bindgen_futures/
futures: Add more documentation and example usage Adds an example future that becomes ready on the next tick of the JavaScript micro task queue. Part of #614 2018-08-09 03:41:36 +03:00			# `wasm-bindgen-futures`
Support asynchronous tests (#600) * Tweak the implementation of heap closures This commit updates the implementation of the `Closure` type to internally store an `Rc` and be suitable for dropping a `Closure` during the execution of the closure. This is currently needed for promises but may be generally useful as well! * Support asynchronous tests This commit adds support for executing tests asynchronously. This is modeled by tests returning a `Future` instead of simply executing inline, and is signified with `#[wasm_bindgen_test(async)]`. Support for this is added through a new `wasm-bindgen-futures` crate which is a binding between the `futures` crate and JS `Promise` objects. Lots more details can be found in the details of the commit, but one of the end results is that the `web-sys` tests are now entirely contained in the same test suite and don't need `npm install` to be run to execute them! * Review tweaks * Add some bindings for `Function.call` to `js_sys` Name them `call0`, `call1`, `call2`, ... for the number of arguments being passed. * Use oneshots channels with `JsFuture` It did indeed clean up the implementation! 2018-08-01 23:52:24 +03:00
futures: Add more documentation and example usage Adds an example future that becomes ready on the next tick of the JavaScript micro task queue. Part of #614 2018-08-09 03:41:36 +03:00			`[API Documention][docs]`
Support asynchronous tests (#600) * Tweak the implementation of heap closures This commit updates the implementation of the `Closure` type to internally store an `Rc` and be suitable for dropping a `Closure` during the execution of the closure. This is currently needed for promises but may be generally useful as well! * Support asynchronous tests This commit adds support for executing tests asynchronously. This is modeled by tests returning a `Future` instead of simply executing inline, and is signified with `#[wasm_bindgen_test(async)]`. Support for this is added through a new `wasm-bindgen-futures` crate which is a binding between the `futures` crate and JS `Promise` objects. Lots more details can be found in the details of the commit, but one of the end results is that the `web-sys` tests are now entirely contained in the same test suite and don't need `npm install` to be run to execute them! * Review tweaks * Add some bindings for `Function.call` to `js_sys` Name them `call0`, `call1`, `call2`, ... for the number of arguments being passed. * Use oneshots channels with `JsFuture` It did indeed clean up the implementation! 2018-08-01 23:52:24 +03:00
futures: Add more documentation and example usage Adds an example future that becomes ready on the next tick of the JavaScript micro task queue. Part of #614 2018-08-09 03:41:36 +03:00			This crate bridges the gap between a Rust `Future` and a JavaScript
			`Promise`. It provides two conversions:
Support asynchronous tests (#600) * Tweak the implementation of heap closures This commit updates the implementation of the `Closure` type to internally store an `Rc` and be suitable for dropping a `Closure` during the execution of the closure. This is currently needed for promises but may be generally useful as well! * Support asynchronous tests This commit adds support for executing tests asynchronously. This is modeled by tests returning a `Future` instead of simply executing inline, and is signified with `#[wasm_bindgen_test(async)]`. Support for this is added through a new `wasm-bindgen-futures` crate which is a binding between the `futures` crate and JS `Promise` objects. Lots more details can be found in the details of the commit, but one of the end results is that the `web-sys` tests are now entirely contained in the same test suite and don't need `npm install` to be run to execute them! * Review tweaks * Add some bindings for `Function.call` to `js_sys` Name them `call0`, `call1`, `call2`, ... for the number of arguments being passed. * Use oneshots channels with `JsFuture` It did indeed clean up the implementation! 2018-08-01 23:52:24 +03:00
futures: Add more documentation and example usage Adds an example future that becomes ready on the next tick of the JavaScript micro task queue. Part of #614 2018-08-09 03:41:36 +03:00			1. From a JavaScript `Promise` into a Rust `Future`.
			2. From a Rust `Future` into a JavaScript `Promise`.
Support asynchronous tests (#600) * Tweak the implementation of heap closures This commit updates the implementation of the `Closure` type to internally store an `Rc` and be suitable for dropping a `Closure` during the execution of the closure. This is currently needed for promises but may be generally useful as well! * Support asynchronous tests This commit adds support for executing tests asynchronously. This is modeled by tests returning a `Future` instead of simply executing inline, and is signified with `#[wasm_bindgen_test(async)]`. Support for this is added through a new `wasm-bindgen-futures` crate which is a binding between the `futures` crate and JS `Promise` objects. Lots more details can be found in the details of the commit, but one of the end results is that the `web-sys` tests are now entirely contained in the same test suite and don't need `npm install` to be run to execute them! * Review tweaks * Add some bindings for `Function.call` to `js_sys` Name them `call0`, `call1`, `call2`, ... for the number of arguments being passed. * Use oneshots channels with `JsFuture` It did indeed clean up the implementation! 2018-08-01 23:52:24 +03:00
futures: Add more documentation and example usage Adds an example future that becomes ready on the next tick of the JavaScript micro task queue. Part of #614 2018-08-09 03:41:36 +03:00			`See the [API documentation][docs] for more info.`

			`[docs]: https://rustwasm.github.io/wasm-bindgen/api/wasm_bindgen_futures/`