Skip to content

Commit

Permalink
docs: Explicitly state that WASI is experimental in node (#863)
Browse files Browse the repository at this point in the history
  • Loading branch information
saulecabrera authored Dec 20, 2024
1 parent 26a21ce commit 4c1c980
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/docs-using-nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,20 @@
This example demonstrates how to run Javy in a Node.js (v20+) host application.

## Warning
This example does NOT show how to run a Node.js application in Javy. This is useful for when you want to run untrusted user generated code in a sandbox. This code is meant to be an example not production-ready code.
This example does NOT show how to run a Node.js application in Javy. This is
useful for when you want to run untrusted user generated code in a sandbox. This
code is meant to be an example not production-ready code.

It's also important to note that the WASI implementation in NodeJS is currently
considered [experimental].

[experimental]: https://nodejs.org/api/wasi.html#webassembly-system-interface-wasi

## Summary
This example shows how to use a dynamically linked Javy compiled Wasm module. We use std in/out/error to communicate with the embedded javascript see [this blog post](https://k33g.hashnode.dev/wasi-communication-between-nodejs-and-wasm-modules-another-way-with-stdin-and-stdout) for details.
This example shows how to use a dynamically linked Javy compiled Wasm module. We
use std in/out/error to communicate with the embedded javascript see [this blog
post](https://k33g.hashnode.dev/wasi-communication-between-nodejs-and-wasm-modules-another-way-with-stdin-and-stdout)
for details.


### Steps
Expand Down

0 comments on commit 4c1c980

Please sign in to comment.