summaryrefslogtreecommitdiffstats
path: root/vendor/wasm-bindgen-futures/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/wasm-bindgen-futures/README.md')
-rw-r--r--vendor/wasm-bindgen-futures/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/vendor/wasm-bindgen-futures/README.md b/vendor/wasm-bindgen-futures/README.md
new file mode 100644
index 000000000..eb0a067f3
--- /dev/null
+++ b/vendor/wasm-bindgen-futures/README.md
@@ -0,0 +1,16 @@
+# `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`.
+
+Additionally under the feature flag `futures-core-03-stream` there is experimental
+support for `AsyncIterator` to `Stream` conversion.
+
+See the [API documentation][docs] for more info.
+
+[docs]: https://rustwasm.github.io/wasm-bindgen/api/wasm_bindgen_futures/