wasm-bindgen/CHANGELOG.md

wasm-bindgen Change Log

---

Unreleased

Released YYYY-MM-DD.

Added

• TODO (or remove section if none)

Changed

• TODO (or remove section if none)

Deprecated

• TODO (or remove section if none)

Removed

• TODO (or remove section if none)

Fixed

• TODO (or remove section if none)

Security

• TODO (or remove section if none)

---

0.2.33

Released 2019-01-18.

Added

• Improved the Debug output of JsValue #1161

• Bindings for JSON.stringify and its optional arguments have been added #1190

Fixed

• A bug with windows binaries being released has ben resolved.

---

0.2.32

Released 2019-01-16.

Added

• Added support for Web IDL sequences. This enabled bindings generation for a couple more Web APIs. We generate functions for Web APIs that take sequences to accept any iterable, and for Web APIs that return sequences, a js_sys::Array is returned. See #1152 and #1038.
• The wasm-bindgen-test test runner will capture console.debug, console.info, and console.warn log messages and print them to stdout now. It already supported console.log and console.error and continues to support them. See #1183 and #1184.
• Added additional --debug-only assertions in the emitted JS glue for cases where an imported JS function that is not annotated with #[wasm_bindgen(catch)] throws an exception. This should help catch some bugs earlier! See #1179.

Fixed

• Fixed a bug where #[wasm_bindgen_test] tests would fail in non-headless Web browsers if they used console.log. See #1167.
• Fixed a bug where returning closures from exported functions sometimes resulted in a faulty error. See #1174 and #1175.
• Sometimes our generated TypeScript interface files had syntax errors in them (missing semicolons). This has been fixed. See #1181.

---

0.2.31

Released 2019-01-09.

Added

• A new spawn_local function has been added to the wasm-bindgen-futures crate. #1148

• Built-in conversions are now available from typed arrays and Rust arrays. #1147

Fixed

• Some casing of dictionary properties in WebIDL has been fixed. #1155

---

0.2.30

Released 2019-01-07.

Added

• The wasm-bindgen CLI now has an --out-name argument to name the output module. #1084

• Support for importing the default export has been added. #1106

Changed

• All web-sys methods are now flagged as structural, fixing a few bindings. #1117

Fixed

• A small bug with LTO and closures has been fixed. #1145

---

0.2.29

Released 2018-12-04.

Added

• Add a #[wasm_bindgen(start)] attribute to customize the start section of the wasm module. #1057

• Add support for producing the new "producers" section of wasm binaries #1041

• Add support a typescript_custom_section attribute for producing custom typescript abstractions #1048

• Generate *.d.ts files for wasm files in addition to the JS bindings #1053

• Add a feature to assert that all attributes in #[wasm_bindgen] are used to help catch typos and mistakes #1055

Changed

• JS glue generation has received a few small optimizations such as removing shims and removing object allocations #1033 #1030

• JS glue now just uses one array of JS objects instead of two #1069

Fixed

• Fix a typo in the --no-modules generated JS #1045

---

0.2.28

Released 2018-11-12.

Added

• The js_class support is now supported on exported types to define a different class in JS than is named in Rust #1012

• More WebIDL bindings are exposed with some internal restructuring to ignore unimplemented types at a different location #1014

• All imported types now implement Deref to their first extends attribute (or JsValue if one isn't listed). This is intended to greatly improve the ergonomics of web-sys bindings by allowing easy access to parent class methods #1019

• A new attribute, final, can be applied to JS imports. This attribute is relatively nuanced and best explained in documentation, but is added since structural is now the default #1019

• A new CLI flag, --remove-name-section, can be passed to remove the wasm name section which contains the names of functions for debugging (typically not needed in release mode) #1024

Changed

• All imported functions are now structural by default. This shouldn't change the semantics of imported functions, only how they're invoked in the JS function shims that are generated by wasm-bindgen. More discussion can be founed on RFC 5 and the PR #1019

• JS glue assertions for moved arguments are now only emitted in debug mode, which is still off by default #1020

Fixed

• Typescript generated bindings now correctly reflect Option<T> for more types #1008

• The JS shim code generation has been optimized for structural bindings (now the default) to include fewer JS shims and more easily optimizable for JS engines #1019

• Passing a WebAssembly.Module to the --no-modules constructor has been fixed #1025

---

0.2.27

Released 2018-10-29.

Fixed

• Fixed an internal panic where the gc passes were being too aggressive #995

---

0.2.26

Released 2018-10-29.

Added

• The TypedArray.slice methods have now been bound in js-sys. #956

• The Debug and Clone traits are now implemented for js_sys::Promise. #957

• The js_sys::DataView type now exposes overloads to specify endianness. #966

• When using --no-modules a WebAssembly.Module can now be directly passed into the instantiation glue. #969

Fixed

• The JsValue type is no longer considered Send. #955

• The generated JS glue is now more robust in the face of missing APIs. #959

• An issue with the latest version of safaridriver used to run headless tests has been resolved. #991

---

0.2.25

Released 2018-10-10.

Fixed

• Using wasm-bindgen will no longer unconditionally pull in Rust's default allocator for Wasm (dlmalloc) regardless if you configured a custom global allocator (eg wee_alloc). #947

• Fixed web-sys build on some Windows machines. #943

• Fixed generated ES class bindings to Rust structs that were only referenced through struct fields. #948

---

0.2.24

Released 2018-10-05.

Added

• Constructors for types in web-sys should now have better documentation.

• A new vendor_prefix attribute in #[wasm_bindgen] is supported to bind APIs on the web which may have a vendor prefix (like webkitAudioContext). This is then subsequently used to fix AudioContext usage in Safari.

• The #[wasm_bindgen(extends = Foo)] attribute now supports full paths, so you can also say #[wasm_bindgen(extends = foo::Bar)] and such.

Changed

• The Closure<T> type is now optimized when the underlying closure is a ZST. The type now no longer allocates memory in this situation.

• The documentation now has a list of caveats for browser support, including how TextEncoder and TextDecoder are not implemented in Edge. If you're using webpack there's a listed strategy available, and improvements to the polyfill strategy are always welcome!

• The BaseAudioContext and AudioScheduledSourceNode types in web-sys have been deprecated as they don't exist in Safari or Edge.

Fixed

• Fixed the #[wasm_bindgen_test]'s error messages in a browser to correctly escape HTML-looking output.

• WebIDL Attributes on Window are now correctly bound to not go through Window.prototype which doesn't exist but instead use a structural definition.

• Fixed a codegen error when the BorrowMut trait was in scope.

• Fixed TypeScript generation for constructors of classes, it was accidentally producing a syntactially invalid file!

---

0.2.23

Released 2018-09-26.

Added

• This is the first release of the web-sys crate!

• Added support for unions of interfaces and non-interfaces in the WebIDL frontend.

• Added a policy for inclusion of new ECMAScript features in js-sys: the feature must be in stage 4 or greater for us to support it.

• Added some documentation about size profiling and optimization with wasm-bindgen to the guide.

• Added the Clamped<T> type for generating JavaScript Uint8ClampedArrays.

• CI is now running on beta! Can't wait for the rustc release trains to roll over, so we can run CI on stable too!

• Added the js_sys::try_iter function, which checks arbitrary JS values for compliance with the JS iteration protocol, and if they are iterable, converts them into an iterator over the JS values that they yield.

Changed

• We now only generate null checks on methods on the JS side when in debug mode. For safety we will always null check on the Rust side, however.

• Improved error messages when defining setters that don't start with set_ and don't use js_name = ....

• Improved generated code for classes in a way that avoids an unnecessary allocation with static methods that return Self but are not the "main" constructor.

• BREAKING: js_sys::Reflect APIs are all fallible now. This is because reflecting on Proxys whose trap handlers throw an exception can cause any of the reflection APIs to throw. Accordingly, js_sys has been bumped from 0.2.X to 0.3.X.

Fixed

• The method of ensuring that __wbindgen_malloc and __wbindgen_free are always emitted in the .wasm binary, regardless of seeming reachability is now zero-overhead.

---

0.2.22

Released 2018-09-21

Added

• The IntoIterator trait is now implemented for JS Iterator types
• A number of variadic methods in js-sys have had explicit arities added.
• The guide has been improved quite a bit as well as enhanced with more examples
• The js-sys crate is now complete! Thanks so much to everyone involved to help fill out all the APIs.
• Exported Rust functions with #[wasm_bindgen] can now return a Result where the Err payload is raised as an exception in JS.

Fixed

• An issue with running wasm-bindgen on crates that have been compiled with LTO has been resolved.

---

0.2.21

Released 2018-09-07

Added

• Added many more bindings for WebAssembly in the js-sys crate.

Fixed

• The "names" section of the wasm binary is now correctly preserved by wasm-bindgen.

---

0.2.20

Released 2018-09-06

Added

• All of wasm-bindgen is configured to compile on stable Rust as of the upcoming 1.30.0 release, scheduled for October 25, 2018.
• The underlying JsValue of a Closure<T> type can now be extracted at any time.
• Initial and experimental support was added for modules that have shared memory (use atomic instructions).

Removed

• The --wasm2asm flag of wasm2es6js was removed because the wasm2asm tool has been removed from upstream Binaryen. This is replaced with the new wasm2js tool from Binaryen.

Fixed

• The "schema" version for wasm-bindgen now changes on all publishes, meaning we can't forget to update it. This means that the crate version and CLI version must exactly match.
• The wasm-bindgen crate now has a links key which forbids multiple versions of wasm-bindgen from being linked into a dependency graph, fixing obscure linking errors with a more first-class error message.
• Binary releases for Windows has been fixed.

---

0.2.19 (and 0.2.18)

Released 2018-08-27.

Added

• Added bindings to js-sys for some WebAssembly types.
• Added bindings to js-sys for some Intl types.
• Added bindings to js-sys for some String methods.
• Added an example of using the WebAudio APIs.
• Added an example of using the fetch API.
• Added more extends annotations for types in js-sys.
• Experimental support for WeakRef was added to automatically deallocate Rust objects when gc'd.
• Added support for executing wasm-bindgen over modules that import their memory.
• Added a global memory() function in the wasm-bindgen crate for accessing the JS object that represent wasm's own memory.

Removed

• Removed AsMut implementations for imported objects.

Fixed

• Fixed the constructor and catch attributes combined on imported types.
• Fixed importing the same-named static in two modules.

---

0.2.17

Released 2018-08-16.

Added

• Greatly expanded documentation in the wasm-bindgen guide.
• Added bindings to js-sys for Intl.DateTimeFormat
• Added a number of extends attributes for types in js-sys

Fixed

• Fixed compile on latest nightly with latest proc-macro2
• Fixed compilation in some scenarios on Windows with paths in module paths

---

0.2.16

Released 2018-08-13.

Added

• Added the wasm_bindgen::JsCast trait, as described in RFC #2.
• Added the #[wasm_bindgen(extends = ...)] attribute to describe inheritance relationships, as described in RFC #2.
• Added support for receiving Option<&T> parameters from JavaScript in exported Rust functions and methods.
• Added support for receiving Option<u32> and other option-wrapped scalars.
• Added reference documentation to the guide for every #[wasm_bindgen] attribute and how it affects the generated bindings.
• Published the wasm-bindgen-futures crate for converting between JS Promises and Rust Futures.

Changed

• Overhauled the guide's documentation on passing JS closures to Rust, and Rust closures to JS.
• Overhauled the guide's documentation on using serde to serialize complex data to JsValue and deserialize JsValues back into complex data.
• Static methods are now always bound to their JS class, as is required for Promise's static methods.

Removed

• Removed internal usage of syn's visit-mut cargo feature, which should result in faster build times.

Fixed

• Various usage errors for the #[wasm_bindgen] proc-macro are now properly reported with source span information, rather than panic!()s inside the proc-macro.
• Fixed a bug where taking a struct by reference and returning a slice resulted in lexical variable redeclaration errors in the generated JS glue. #662
• The #[wasm_bindgen(js_class = "....")] attribute for binding methods to renamed imported JS classes now properly works with constructors.

---

0.2.15

Released 2018-07-26.

Fixed

• Fixed wasm-bindgen CLI version mismatch checks that got broken in the last point release.

---

0.2.14

Released 2018-07-25.

Fixed

• Fixed compilation errors on targets that use Mach-O. #545

---

0.2.13

Released 2018-07-22.

Added

• Support the #[wasm_bindgen(js_name = foo)] attribute on exported functions and methods to allow renaming an export to JS. This allows JS to call it by one name and Rust to call it by another, for example using camelCase in JS and snake_case in Rust

Fixed

• Compilation with the latest nightly compiler has been fixed (nightlies on and after 2018-07-21)

---

0.2.12

Released 2018-07-19.

This release is mostly internal refactorings and minor improvements to the existing crates and functionality, but the bigs news is an upcoming js-sys and web-sys set of crates. The js-sys crate will expose all global JS bindings and the web-sys crate will be generated from WebIDL to expose all APIs browsers have. More info on this soon!

Added

• Support for Option<T> was added where T can be a number of slices or imported types.
• Comments in Rust are now preserved in generated JS bindings, as well as comments being generated to indicate the types of arguments/return values.
• The online documentation has been reorganized into a book.
• The generated JS is now formatted better by default for readability.
• A --keep-debug flag has been added to the CLI to retain debug sections by default. This happens by default when --debug is passed.

Fixed

• Compilation with the latest nightly compiler has been fixed (nightlies on and after 2018-07-19)
• Declarations of an imported function in multiple crates have been fixed to not conflict.
• Compilation with #![deny(missing_docs)] has been fixed.

---

0.2.11

Released 2018-05-24.

---

0.2.10

Released 2018-05-17.

---

0.2.9

Released 2018-05-11.