Update README.md in ruby-head-wasm-wasi

Author: kateinoigakukun

packages/npm-packages/ruby-head-wasm-wasi/README.md

@@ -26,9 +26,9 @@ import { DefaultRubyVM } from "ruby-head-wasm-wasi/dist/node.cjs.js";
 
 const main = async () => {
   const binary = await fs.readFile(
-//  Tips: Replace the binary with debug info if you want symbolicated stack trace.
-//  (only nightly release for now)
-//  "./node_modules/ruby-head-wasm-wasi/dist/ruby.debug.wasm"
+    //  Tips: Replace the binary with debug info if you want symbolicated stack trace.
+    //  (only nightly release for now)
+    //  "./node_modules/ruby-head-wasm-wasi/dist/ruby.debug.wasm"
     "./node_modules/ruby-head-wasm-wasi/dist/ruby.wasm"
   );
   const module = await WebAssembly.compile(binary);
@@ -62,9 +62,9 @@ See [the example project](https://github.com/ruby/ruby.wasm/tree/main/packages/n
     const main = async () => {
       // Fetch and instntiate WebAssembly binary
       const response = await fetch(
-//      Tips: Replace the binary with debug info if you want symbolicated stack trace.
-//      (only nightly release for now)
-//      "https://cdn.jsdelivr.net/npm/ruby-head-wasm-wasi@latest/dist/ruby.debug.wasm"
+        //      Tips: Replace the binary with debug info if you want symbolicated stack trace.
+        //      (only nightly release for now)
+        //      "https://cdn.jsdelivr.net/npm/ruby-head-wasm-wasi@latest/dist/ruby.debug.wasm"
         "https://cdn.jsdelivr.net/npm/ruby-head-wasm-wasi@latest/dist/ruby.wasm"
       );
       const buffer = await response.arrayBuffer();
@@ -85,7 +85,6 @@ See [the example project](https://github.com/ruby/ruby.wasm/tree/main/packages/n
 </html>
 ```
 
-
 ## GC limitation with JavaScript interoperability
 
 Since JavaScript's GC system and Ruby's GC system are separated and not cooperative, they cannot collect cyclic references between JavaScript and Ruby objects.
@@ -107,50 +106,47 @@ class RNode
   end
 end
 RNode.new
-`)
+`);
 
-rnode.call("set_jnode", vm.wrap(jnode))
+rnode.call("set_jnode", vm.wrap(jnode));
 jnode.setRNode(rnode);
 ```
 
-<!-- The APIs section was generated by `npx documentation readme ./dist/index.esm.js --section=APIs` -->
+<!-- The APIs section was generated by `npx documentation readme ../ruby-wasm-wasi/dist/index.esm.js --section=APIs` -->
 
 ## APIs
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 #### Table of Contents
 
-- [ruby-head-wasm-wasi](#ruby-head-wasm-wasi)
-  - [Installation](#installation)
-  - [Quick Start (for Node.js)](#quick-start-for-nodejs)
-  - [Quick Start (for Browser)](#quick-start-for-browser)
-  - [APIs](#apis)
-      - [Table of Contents](#table-of-contents)
-    - [RubyVM](#rubyvm)
-      - [Examples](#examples)
-      - [initialize](#initialize)
-        - [Parameters](#parameters)
-      - [setInstance](#setinstance)
-        - [Parameters](#parameters-1)
-      - [addToImports](#addtoimports)
-        - [Parameters](#parameters-2)
-      - [printVersion](#printversion)
-      - [eval](#eval)
-        - [Parameters](#parameters-3)
-        - [Examples](#examples-1)
-    - [RbValue](#rbvalue)
-      - [Parameters](#parameters-4)
-      - [call](#call)
-        - [Parameters](#parameters-5)
-        - [Examples](#examples-2)
-      - [toPrimitive](#toprimitive)
-        - [Parameters](#parameters-6)
-      - [toString](#tostring)
-      - [toJS](#tojs)
-    - [RbError](#rberror)
-      - [Parameters](#parameters-7)
-  - [Building the package from source](#building-the-package-from-source)
+- [RubyVM](#rubyvm)
+  - [Examples](#examples)
+  - [initialize](#initialize)
+    - [Parameters](#parameters)
+  - [setInstance](#setinstance)
+    - [Parameters](#parameters-1)
+  - [addToImports](#addtoimports)
+    - [Parameters](#parameters-2)
+  - [printVersion](#printversion)
+  - [eval](#eval)
+    - [Parameters](#parameters-3)
+    - [Examples](#examples-1)
+  - [wrap](#wrap)
+    - [Parameters](#parameters-4)
+    - [Examples](#examples-2)
+- [JsValueTransport](#jsvaluetransport)
+- [RbValue](#rbvalue)
+  - [Parameters](#parameters-5)
+  - [call](#call)
+    - [Parameters](#parameters-6)
+    - [Examples](#examples-3)
+  - [toPrimitive](#toprimitive)
+    - [Parameters](#parameters-7)
+  - [toString](#tostring)
+  - [toJS](#tojs)
+- [RbError](#rberror)
+  - [Parameters](#parameters-8)
 
 ### RubyVM
 
@@ -170,6 +166,7 @@ vm.addToImports(imports);
 const instance = await WebAssembly.instantiate(rubyModule, imports);
 await vm.setInstance(instance);
 wasi.initialize(instance);
+vm.initialize();
 ```
 
 #### initialize
@@ -224,6 +221,44 @@ console.log(result.toString()); // 3
 
 Returns **any** the result of the last expression
 
+#### wrap
+
+Wrap a JavaScript value into a Ruby JS::Object
+
+##### Parameters
+
+- `value` The value to convert to RbValue
+
+##### Examples
+
+```javascript
+const hash = vm.eval(`Hash.new`);
+hash.call("store", vm.eval(`"key1"`), vm.wrap(new Object()));
+```
+
+Returns **any** the RbValue object representing the given JS value
+
+### JsValueTransport
+
+Export a JS value held by the Ruby VM to the JS environment.
+This is implemented in a dirty way since wit cannot reference resources
+defined in other interfaces.
+In our case, we can't express `function(v: rb-abi-value) -> js-abi-value`
+because `rb-js-abi-host.wit`, that defines `js-abi-value`, is implemented
+by embedder side (JS) but `rb-abi-guest.wit`, that defines `rb-abi-value`
+is implemented by guest side (Wasm).
+
+This class is a helper to export by:
+
+1.  Call `function __export_to_js(v: rb-abi-value)` defined in guest from embedder side.
+2.  Call `function takeJsValue(v: js-abi-value)` defined in embedder from guest side with
+    underlying JS value of given `rb-abi-value`.
+3.  Then `takeJsValue` implementation escapes the given JS value to the `_takenJsValues`
+    stored in embedder side.
+4.  Finally, embedder side can take `_takenJsValues`.
+
+Note that `exportJsValue` is not reentrant.
+
 ### RbValue
 
 A RbValue is an object that represents a value in Ruby
@@ -232,7 +267,7 @@ A RbValue is an object that represents a value in Ruby
 
 - `inner`
 - `vm`
-- `exporter`
+- `privateObject`
 
 #### call