Add doc comment for RubyVM.evalAsync

kateinoigakukun · kateinoigakukun · commit 98c306aa64dc · 2022-11-06T09:09:45.000+09:00
diff --git a/packages/npm-packages/ruby-head-wasm-wasi/README.md b/packages/npm-packages/ruby-head-wasm-wasi/README.md
@@ -131,15 +131,18 @@ jnode.setRNode(rnode);
   - [eval](#eval)
     - [Parameters](#parameters-3)
     - [Examples](#examples-1)
-  - [wrap](#wrap)
+  - [evalAsync](#evalasync)
     - [Parameters](#parameters-4)
     - [Examples](#examples-2)
-- [RbValue](#rbvalue)
-  - [call](#call)
+  - [wrap](#wrap)
     - [Parameters](#parameters-5)
     - [Examples](#examples-3)
-  - [toPrimitive](#toprimitive)
+- [RbValue](#rbvalue)
+  - [call](#call)
     - [Parameters](#parameters-6)
+    - [Examples](#examples-4)
+  - [toPrimitive](#toprimitive)
+    - [Parameters](#parameters-7)
   - [toString](#tostring)
   - [toJS](#tojs)
 - [RbError](#rberror)
@@ -217,6 +220,28 @@ console.log(result.toString()); // 3
 
 Returns **any** the result of the last expression
 
+#### evalAsync
+
+Runs a string of Ruby code with top-level `JS::Object#await`
+Returns a promise that resolves when execution completes.
+
+##### Parameters
+
+- `code` The Ruby code to run
+
+##### Examples
+
+```javascript
+const text = await vm.evalAsync(`
+  require 'js'
+  response = JS.global.fetch('https://example.com').await
+  response.text.await
+`);
+console.log(text.toString()); // <html>...</html>
+```
+
+Returns **any** a promise that resolves to the result of the last expression
+
 #### wrap
 
 Wrap a JavaScript value into a Ruby JS::Object
diff --git a/packages/npm-packages/ruby-wasm-wasi/src/index.ts b/packages/npm-packages/ruby-wasm-wasi/src/index.ts
@@ -225,6 +225,20 @@ export class RubyVM {
     return evalRbCode(this, this.privateObject(), code);
   }
 
+  /**
+   * Runs a string of Ruby code with top-level `JS::Object#await`
+   * Returns a promise that resolves when execution completes.
+   * @param code The Ruby code to run
+   * @returns a promise that resolves to the result of the last expression
+   *
+   * @example
+   * const text = await vm.evalAsync(`
+   *   require 'js'
+   *   response = JS.global.fetch('https://example.com').await
+   *   response.text.await
+   * `);
+   * console.log(text.toString()); // <html>...</html>
+   */
   evalAsync(code: string): Promise<RbValue> {
     const JS = this.eval("require 'js'; JS");
     return new Promise((resolve, reject) => {
