chore(core): add log prop to PlatformRunScenarioOpts

LavaMoat · Feb 29, 2024 · a2bc3ab · a2bc3ab
1 parent 2bb1bfb
commit a2bc3ab
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/core/test/util.js b/packages/core/test/util.js
@@ -338,13 +338,20 @@ function createHookedConsole() {
 }
 
 /**
+ * Options for {@link PlatformRunScenario}
+ *
  * @template [Result=unknown] Default is `unknown`
  * @typedef PlatformRunScenarioOpts
  * @property {import('./scenarios/scenario').NormalizedScenario<Result>} scenario
  * @property {boolean} [runWithPrecompiledModules]
+ * @property {(...args: any[]) => void} [log]
  */
 
 /**
+ * Scenario runner function provided by the consuming platform.
+ *
+ * Called by {@link runAndTestScenario}
+ *
  * @template [Result=unknown] Default is `unknown`
  * @callback PlatformRunScenario
  * @param {PlatformRunScenarioOpts<Result>} opts