From 4c1c9804f5ba173cdaa88506e0260728e4cc7d59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Cabrera?= Date: Fri, 20 Dec 2024 08:48:13 -0600 Subject: [PATCH] docs: Explicitly state that WASI is experimental in node (#863) --- docs/docs-using-nodejs.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/docs-using-nodejs.md b/docs/docs-using-nodejs.md index f8ec83e0..5ea466af 100644 --- a/docs/docs-using-nodejs.md +++ b/docs/docs-using-nodejs.md @@ -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