Skip to content
OriginTS

run

run<Out>(plan, ctx): Promise<RunResult<Out>>

Defined in: execution/run.ts:77

Execute a plan with the given context.

Type Parameters

Section titled “Type Parameters”

Out

Section titled “Out”

Out

Parameters

Section titled “Parameters”

plan

Section titled “plan”

Plan<Out>

The compiled plan to execute

ctx

Section titled “ctx”

RunContext = {}

Optional execution context (readFile, glob, registry)

Returns

Section titled “Returns”

Promise<RunResult<Out>>

Promise resolving to success with value or failure with errors

Example

Section titled “Example”
// DirectInput only - no context needed
const result = await run(plan)


// With file access
const result = await run(plan, { readFile: myReadFile })


// With custom registry
const result = await run(plan, { readFile: myReadFile, registry: customRegistry })