mirror of
https://github.com/fluencelabs/wasm-bindgen
synced 2025-05-14 14:51:20 +00:00
995be7c027
This commit deprecates the `--web`, `--no-modules`, and `--nodejs` flags in favor of one `--target` flag. The motivation for this commit is to be consistent between `wasm-bindgen` and `wasm-pack` so documentation for one is applicable for the other (so we don't have to document everywhere what the translation is between flags). Additionally this should make it a bit easier to add new targets (if necessary) in the future as it won't add to the proliferation of flags. For now the old flags (like `--web`) continue to be accepted, but they'll be removed during the next set of breaking changes for `wasm-bindgen`.
71 lines
2.0 KiB
Markdown
71 lines
2.0 KiB
Markdown
# The `wasm-bindgen` Command Line Interface
|
|
|
|
The `wasm-bindgen` command line tool has a number of options available to it to
|
|
tweak the JavaScript that is generated. The most up-to-date set of flags can
|
|
always be listed via `wasm-bindgen --help`.
|
|
|
|
> Note: usually, one should use a [`wasm-pack`-based workflow][wasm-pack] rather
|
|
> than running the `wasm-bindgen` command line tool by hand.
|
|
|
|
[wasm-pack]: https://github.com/rustwasm/wasm-pack
|
|
|
|
## Usage
|
|
|
|
```
|
|
wasm-bindgen [options] ./target/wasm32-unknown-unknown/release/crate.wasm
|
|
```
|
|
|
|
## Options
|
|
|
|
### `--out-dir DIR`
|
|
|
|
The target directory to emit the JavaScript bindings, TypeScript definitions,
|
|
processed `.wasm` binary, etc...
|
|
|
|
### `--target`
|
|
|
|
This flag indicates what flavor of output what `wasm-bindgen` should generate.
|
|
For example it could generate code to be loaded in a bundler like Webpack, a
|
|
native web page, or Node.js. For a full list of options to pass this flag, see
|
|
the section on [deployment]
|
|
|
|
[deployment]: deployment.html
|
|
|
|
### `--no-modules-global VAR`
|
|
|
|
When `--target no-modules` is used this flag can indicate what the name of the
|
|
global to assign generated bindings to.
|
|
|
|
For more information about this see the section on [deployment]
|
|
|
|
### `--typescript`
|
|
|
|
Output a TypeScript declaration file for the generated JavaScript bindings. This
|
|
is on by default.
|
|
|
|
### `--no-typescript`
|
|
|
|
By default, a `*.d.ts` TypeScript declaration file is generated for the
|
|
generated JavaScript bindings, but this flag will disable that.
|
|
|
|
### `--debug`
|
|
|
|
Generates a bit more JS and wasm in "debug mode" to help catch programmer
|
|
errors, but this output isn't intended to be shipped to production.
|
|
|
|
### `--no-demangle`
|
|
|
|
When post-processing the `.wasm` binary, do not demangle Rust symbols in the
|
|
"names" custom section.
|
|
|
|
### `--keep-debug`
|
|
|
|
When post-processing the `.wasm` binary, do not strip DWARF debug info custom
|
|
sections.
|
|
|
|
### `--browser`
|
|
|
|
When generating bundler-compatible code (see the section on [deployment]) this
|
|
indicates that the bundled code is always intended to go into a browser so a few
|
|
checks for Node.js can be elided.
|