Skip to content

docs(rust-plugins): update readme #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CCherry07 merged 2 commits into from
Feb 25, 2025
Merged

docs(rust-plugins): update readme #122

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69cfc0f
docs(rust-plugins): update readme
fu050409 Feb 25, 2025
006c0b7
Merge branch 'main' into docs/update-wasm-readme
fu050409 Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions rust-plugins/wasm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @farmfe/plugin-wasm

A farm plugin for importing Wasm modules.
A Farm plugin for seamless WebAssembly integration and support `wasm-pack` generated modules.

## Installation

Expand Down Expand Up @@ -48,4 +48,9 @@ init({
});
```

In production builds, `.wasm` files smaller than the `assetInlineLimit` will be inlined as base64 strings. Otherwise, they will be treated as static assets and fetched on demand.
You can also directly import WASM packages like ESM modules without using the `?init` query:

```ts
import { someFunc } from 'wasm-project';
someFunc(); // Run this wasm function
```