ChainGraph API Documentation / @badaitech/chaingraph-types / ExecutionEngine
Class: ExecutionEngine
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:45
Constructors
Constructor
new ExecutionEngine(
flow,context,options?,onBreakpointHit?):ExecutionEngine
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:62
Parameters
flow
context
options?
breakpoints?
string[] = ...
debug?
boolean = ...
execution?
{ flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; } = ...
execution.flowTimeoutMs?
number = ...
execution.maxConcurrency?
number = ...
execution.nodeTimeoutMs?
number = ...
onBreakpointHit?
(node) => void
Returns
ExecutionEngine
Methods
createEvent()
createEvent<
T>(type,data):ExecutionEventImpl<T>
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:770
Type Parameters
T
T extends ExecutionEventEnum
Parameters
type
T
data
Returns
execute()
execute(
onComplete?):Promise<void>
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:90
Parameters
onComplete?
(context, eventQueue) => Promise<void>
Returns
Promise<void>
getDebugger()
getDebugger():
DebuggerController|null
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:737
Returns
DebuggerController | null
getOptions()
getOptions(): {
breakpoints?:string[];debug?:boolean;execution?: {flowTimeoutMs?:number;maxConcurrency?:number;nodeTimeoutMs?:number; }; } |undefined
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:741
Returns
{ breakpoints?: string[]; debug?: boolean; execution?: { flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; }; } | undefined
on()
on<
T>(type,handler): () =>void
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:745
Type Parameters
T
T extends ExecutionEventEnum
Parameters
type
T
handler
(event) => void | Promise<void>
Returns
():
void
Returns
void
onAll()
onAll(
handler): () =>void
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:759
Parameters
handler
(event) => void | Promise<void>
Returns
():
void
Returns
void
setEventCallback()
setEventCallback(
callback):void
Defined in: packages/chaingraph-types/src/flow/execution-engine.ts:766
Set a callback to be called when events are emitted
Parameters
callback
(context) => Promise<void>
Returns
void