npm - @ruby/wasm-wasi - Versions diffs - 2.6.2 → 2.7.0 - Mend

@ruby/wasm-wasi 2.6.2 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/README.md +1 -232
package/dist/browser.script.umd.js +166 -130
package/dist/browser.umd.js +146 -129
package/dist/cjs/bindgen/interfaces/ruby-js-js-runtime.d.ts +1 -1
package/dist/cjs/bindgen/interfaces/ruby-js-ruby-runtime.d.ts +2 -9
package/dist/cjs/bindgen/legacy/intrinsics.js +5 -5
package/dist/cjs/bindgen/legacy/rb-abi-guest.d.ts +1 -31
package/dist/cjs/bindgen/legacy/rb-abi-guest.js +16 -84
package/dist/cjs/bindgen/legacy/rb-js-abi-host.js +1 -2
package/dist/cjs/binding.d.ts +2 -8
package/dist/cjs/binding.js +2 -11
package/dist/cjs/browser.js +9 -11
package/dist/cjs/browser.script.d.ts +14 -0
package/dist/cjs/browser.script.js +22 -2
package/dist/cjs/console.js +1 -2
package/dist/cjs/node.d.ts +0 -1
package/dist/cjs/node.js +1 -9
package/dist/cjs/vm.d.ts +157 -19
package/dist/cjs/vm.js +120 -21
package/dist/esm/bindgen/interfaces/ruby-js-js-runtime.d.ts +1 -1
package/dist/esm/bindgen/interfaces/ruby-js-ruby-runtime.d.ts +2 -9
package/dist/esm/bindgen/legacy/rb-abi-guest.d.ts +1 -31
package/dist/esm/bindgen/legacy/rb-abi-guest.js +15 -82
package/dist/esm/binding.d.ts +2 -8
package/dist/esm/binding.js +2 -11
package/dist/esm/browser.js +9 -11
package/dist/esm/browser.script.d.ts +14 -0
package/dist/esm/browser.script.js +19 -0
package/dist/esm/node.d.ts +0 -1
package/dist/esm/node.js +1 -9
package/dist/esm/vm.d.ts +157 -19
package/dist/esm/vm.js +120 -21
package/dist/index.umd.js +137 -118
package/package.json +8 -9

package/README.md CHANGED Viewed

@@ -16,235 +16,4 @@ See [Cheat Sheet](https://github.com/ruby/ruby.wasm/blob/main/docs/cheat_sheet.m
 ## API
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-### consolePrinter
-Create a console printer that can be used as an overlay of WASI imports.
-See the example below for how to use it.
-```javascript
-const imports = {
-  wasi_snapshot_preview1: wasi.wasiImport,
-};
-const printer = consolePrinter();
-printer.addToImports(imports);
-const instance = await WebAssembly.instantiate(module, imports);
-printer.setMemory(instance.exports.memory);
-```
-Note that the `stdout` and `stderr` functions are called with text, not
-bytes. This means that bytes written to stdout/stderr will be decoded as
-UTF-8 and then passed to the `stdout`/`stderr` functions every time a write
-occurs without buffering.
-#### Parameters
-- `$0` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{stdout:console.log,stderr:console.warn}`)
-  - `$0.stdout` &#x20;
-  - `$0.stderr` &#x20;
-- `stdout` A function that will be called when stdout is written to.
-  Defaults to `console.log`.
-- `stderr` A function that will be called when stderr is written to.
-  Defaults to `console.warn`.
-Returns **any** An object that can be used as an overlay of WASI imports.
-### RubyVM
-A Ruby VM instance
-#### Examples
-```javascript
-const wasi = new WASI();
-const vm = new RubyVM();
-const imports = {
-  wasi_snapshot_preview1: wasi.wasiImport,
-};
-vm.addToImports(imports);
-const instance = await WebAssembly.instantiate(rubyModule, imports);
-await vm.setInstance(instance);
-wasi.initialize(instance);
-vm.initialize();
-```
-#### initialize
-Initialize the Ruby VM with the given command line arguments
-##### Parameters
-- `args` The command line arguments to pass to Ruby. Must be
-  an array of strings starting with the Ruby program name. (optional, default `["ruby.wasm","-EUTF-8","-e_=0"]`)
-#### setInstance
-Set a given instance to interact JavaScript and Ruby's
-WebAssembly instance. This method must be called before calling
-Ruby API.
-##### Parameters
-- `instance` The WebAssembly instance to interact with. Must
-  be instantiated from a Ruby built with JS extension, and built
-  with Reactor ABI instead of command line.
-#### addToImports
-Add intrinsic import entries, which is necessary to interact JavaScript
-and Ruby's WebAssembly instance.
-##### Parameters
-- `imports` The import object to add to the WebAssembly instance
-#### printVersion
-Print the Ruby version to stdout
-#### eval
-Runs a string of Ruby code from JavaScript
-##### Parameters
-- `code` The Ruby code to run
-##### Examples
-```javascript
-vm.eval("puts 'hello world'");
-const result = vm.eval("1 + 2");
-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
-##### 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
-### RbValue
-A RbValue is an object that represents a value in Ruby
-#### call
-Call a given method with given arguments
-##### Parameters
-- `callee` name of the Ruby method to call
-- `args` **...any** arguments to pass to the method. Must be an array of RbValue
-##### Examples
-```javascript
-const ary = vm.eval("[1, 2, 3]");
-ary.call("push", vm.wrap(4));
-console.log(ary.call("sample").toString());
-```
-Returns **any** The result of the method call as a new RbValue.
-#### callAsync
-Call a given method that may call `JS::Object#await` with given arguments
-##### Parameters
-- `callee` name of the Ruby method to call
-- `args` **...any** arguments to pass to the method. Must be an array of RbValue
-##### Examples
-```javascript
-const client = vm.eval(`
-  require 'js'
-  class HttpClient
-    def get(url)
-      JS.global.fetch(url).await
-    end
-  end
-  HttpClient.new
-`);
-const response = await client.callAsync(
-  "get",
-  vm.eval(`"https://example.com"`),
-);
-```
-Returns **any** A Promise that resolves to the result of the method call as a new RbValue.
-#### toPrimitive
-- **See**: <https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive>
-##### Parameters
-- `hint` Preferred type of the result primitive value. `"number"`, `"string"`, or `"default"`.
-#### toString
-Returns a string representation of the value by calling `to_s`
-#### toJS
-Returns a JavaScript object representation of the value
-by calling `to_js`.
-Returns null if the value is not convertible to a JavaScript object.
-### RbError
-**Extends Error**
-Error class thrown by Ruby execution
-### RbFatalError
-**Extends RbError**
-Error class thrown by Ruby execution when it is not possible to recover.
-This is usually caused when Ruby VM is in an inconsistent state.
+See [API Documentation](https://ruby.github.io/ruby.wasm/npm/@ruby/wasm-wasi/) for details.