@executablemd/runtime 0.3.0 → 0.4.0

package/esm/apis.js

@@ -49,7 +49,7 @@
  *
  * Middleware is **scoped** — it only affects operations within the
  * current Effection scope and its children. Install before calling
- * `runDocument()` or `durableRun()`.
+ * `execute()` or `durableRun()`.
  *
  * ## Test stubs
  *
@@ -63,9 +63,6 @@ import { fetch as effectionFetch } from "@effectionx/fetch";
 import { readTextFile as fsReadTextFile, stat as fsStat, globToRegExp, walk } from "@effectionx/fs";
 import { exec as processExec } from "@effectionx/process";
 import { each, race, sleep } from "effection";
-// ---------------------------------------------------------------------------
-// Private helpers
-// ---------------------------------------------------------------------------
 function* withTimeout(label, timeout, operation) {
     if (timeout === undefined) {
         return yield* operation;
@@ -81,9 +78,6 @@ function* withTimeout(label, timeout, operation) {
         })(),
     ]));
 }
-// ---------------------------------------------------------------------------
-// Context APIs
-// ---------------------------------------------------------------------------
 export const API = {
     /**
      * Subprocess execution.
@@ -220,12 +214,6 @@ export const API = {
         },
     }),
 };
-// ---------------------------------------------------------------------------
-// Convenience operation exports
-//
-// Use these for normal operation calls. Use API.* only when installing
-// middleware with .around().
-// ---------------------------------------------------------------------------
 export const exec = API.Process.operations.exec;
 export const readTextFile = API.Fs.operations.readTextFile;
 export const stat = API.Fs.operations.stat;

package/esm/test/stubs.js

@@ -3,7 +3,7 @@
  *
  * These helpers install `around()` middleware on the runtime context APIs
  * to replace real I/O with in-memory implementations. They are scoped to
- * the current Effection scope — call them before `runDocument()` or
+ * the current Effection scope — call them before `execute()` or
  * `durableRun()` in your test body.
  *
  * @example
@@ -14,7 +14,7 @@
  *   yield* useStubFs({ "doc.md": "# Hello\n" });
  *   yield* useEchoExec();
  *
- *   const execution = yield* runDocument({ docPath: "doc.md", stream });
+ *   const execution = yield* execute({ docPath: "doc.md", stream });
  *   const output = yield* execution;
  * });
  * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@executablemd/runtime",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Runtime host APIs for executable.md documents.",
   "homepage": "https://executable.md",
   "repository": {

package/types/apis.d.ts

@@ -49,7 +49,7 @@
  *
  * Middleware is **scoped** — it only affects operations within the
  * current Effection scope and its children. Install before calling
- * `runDocument()` or `durableRun()`.
+ * `execute()` or `durableRun()`.
  *
  * ## Test stubs
  *

package/types/test/stubs.d.ts

@@ -3,7 +3,7 @@
  *
  * These helpers install `around()` middleware on the runtime context APIs
  * to replace real I/O with in-memory implementations. They are scoped to
- * the current Effection scope — call them before `runDocument()` or
+ * the current Effection scope — call them before `execute()` or
  * `durableRun()` in your test body.
  *
  * @example
@@ -14,7 +14,7 @@
  *   yield* useStubFs({ "doc.md": "# Hello\n" });
  *   yield* useEchoExec();
  *
- *   const execution = yield* runDocument({ docPath: "doc.md", stream });
+ *   const execution = yield* execute({ docPath: "doc.md", stream });
  *   const output = yield* execution;
  * });
  * ```