Raw bindings to Web APIs for projects using
This crate by default contains very little when compiled as almost all of its
exposed APIs are gated by Cargo features. The exhaustive list of features can be
crates/web-sys/Cargo.toml, but the rule of thumb for
that each type has its own cargo feature (named after the type). Using an API
requires enabling the features for all types used in the API, and APIs should
mention in the documentation what features they require.
How to add an interface
If you don't see a particular web API in
web-sys, here is how to add it.
- Copy the WebIDL specification of the API and place it in a new file in the
webidls/unstablefolder. You can often find the IDL by going to the MDN docs page for the API, scrolling to the bottom, clicking the "Specifications" link, and scrolling to the bottom of the specification page. For example, the bottom of the MDN docs on the MediaSession API takes you to the spec. The very bottom of that page is the IDL.
- Annotate the functions that can throw with
cargo run --release --package wasm-bindgen-webidl -- webidls src/features ./Cargo.toml
git add .to add all the generated files into git.