fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-03-31 17:31:06 +00:00
Code Issues Projects Releases Wiki Activity

Document --no-modules in the README

Browse Source
This commit is contained in:
Alex Crichton 2018-04-13 07:47:16 -07:00
parent 8854936599
commit 5d52bf81c5
1 changed files with 7 additions and 0 deletions

7
README.md

@ -540,6 +540,13 @@ some notable options are:
making it incompatible with Node. This will basically make the generated JS a making it incompatible with Node. This will basically make the generated JS a
tiny bit smaller as runtime checks for Node won't be necessary. tiny bit smaller as runtime checks for Node won't be necessary.
* `--no-modules` - the default output of `wasm-bindgen` uses ES modules but this
option indicates that ES modules should not be used and output should be
tailored for a web browser. In this mode `window.wasm_bindgen` will be a
function that takes a path to the wasm file to fetch and instantiate.
Afterwards exported functions from the wasm are available through
`window.wasm_bindgen.foo`.
* `--typescript` - when passed a `*.d.ts` file will be generated for the * `--typescript` - when passed a `*.d.ts` file will be generated for the
generated JS file. This should allow hooking into TypeScript projects to generated JS file. This should allow hooking into TypeScript projects to
ensure everything still typechecks. ensure everything still typechecks.