Graphite/frontend/wasm/README.md

14 lines
814 B
Markdown

# Overview of `/frontend/wasm/`
## WASM wrapper API: `src/editor_api.rs`
Provides bindings for JS to call functions defined in this file, and for FrontendMessages to be sent from Rust back to JS in the form of a callback to the subscription router. This WASM wrapper crate, since it's written in Rust, is able to call into the Editor crate's codebase and send FrontendMessages back to JS.
## WASM wrapper helper code: `src/helpers.rs`
Assorted function and struct definitions used in the WASM wrapper.
## WASM wrapper initialization: `src/lib.rs`
Entry point for the Rust entire codebase in the WASM environment. Initializes the WASM module and persistent storage for editor and WASM wrapper instances.
## WASM wrapper tests: `tests/`
We currently have no WASM wrapper tests, but this is where they would go.