Skip to content

rulvar API reference


rulvar API reference / @rulvar/cli / driveRun

Function: driveRun()

ts
function driveRun(options): Promise<RunOutcome<unknown>>;

Defined in: packages/cli/src/drive.ts:83

Drives a handle to a terminal outcome, resolving suspensions interactively and resuming until the run settles or input runs dry.

Parameters

ParameterTypeDescription
options{ args?: unknown; engine: Engine; first: RunHandle&lt;unknown&gt;; io: CliIo; workflow: Workflow&lt;never, unknown&gt;; }-
options.args?unknownOriginal run arguments: not journaled in v1, the host re-supplies them.
options.engineEngine-
options.firstRunHandle&lt;unknown&gt;-
options.ioCliIo-
options.workflowWorkflow&lt;never, unknown&gt;-

Returns

Promise&lt;RunOutcome&lt;unknown&gt;&gt;