@eryx-org/eryx 0.15.0 → 0.15.1

package/eryx-sandbox.d.ts

@@ -52,6 +52,9 @@ import type * as WasiSocketsUdpCreateSocket from './interfaces/wasi-sockets-udp-
 import type * as WasiSocketsUdp from './interfaces/wasi-sockets-udp.js'; // wasi:sockets/udp@0.2.0
 export interface ImportObject {
   invoke: {
+    /**
+    * @throws {string} To return the error of the result, throw it, or an `Error` that has it as its `payload`.
+    */
     "default"(name: string, argumentsJson: string): Promise<string>,
   },
   sleep: {
@@ -98,12 +101,24 @@ export interface ImportObject {
   "wasi:sockets/udp@0.2.0": typeof WasiSocketsUdp,
 }
 export interface Root {
+  /**
+  * @throws {Error & { payload: ExecuteError }} The error of the result, as the `payload` of the thrown error.
+  */
   execute(code: string): Promise<ExecuteOutput>,
+  /**
+  * @throws {Error & { payload: string }} The error of the result, as the `payload` of the thrown error.
+  */
   snapshotState(): Promise<StateSnapshot>,
+  /**
+  * @throws {Error & { payload: string }} The error of the result, as the `payload` of the thrown error.
+  */
   restoreState(data: Uint8Array): Promise<void>,
   clearState(): Promise<void>,
   finalizePreinit(): void,
   setResultVariable(name: string): Promise<void>,
+  /** Permanently stop this instance and dispose guest-owned host resources. */
+  readonly _util: { stop(): void; whenIdle(): Promise<void>;  /** Test whether a value is a declared WIT result error from this instance. */
+  isComponentError(value: unknown): value is Error & { readonly payload: unknown }; };
 }
 export type Result<T, E> = { tag: 'ok', val: T } | { tag: 'err', val: E };
 
@@ -111,6 +126,13 @@ export type Result<T, E> = { tag: 'ok', val: T } | { tag: 'err', val: E };
 * Options accepted by `instantiate`.
 */
 export interface InstantiateOptions {
+  /**
+  * Called with each trap of this instance as it happens, in whichever
+  * task: including one a guest left running, which no call of the host's
+  * would otherwise fail for. Not called for stopping the instance, which
+  * it may do itself.
+  */
+  onTrap?: (error: WebAssembly.RuntimeError) => void;
   /** Runtime overrides for this instance. */
   shim?: {
     /** Platform globals used instead of those on `globalThis`. */