Skip to content

PersistentAI API Documentation / @persistentai/fireflow-types / ExecutionEngine

Class: ExecutionEngine

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:49

Constructors

Constructor

new ExecutionEngine(flow, context, options?, onBreakpointHit?): ExecutionEngine

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:78

Parameters

flow

Flow

context

ExecutionContext

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/fireflow-types/src/flow/execution-engine.ts:1028

Type Parameters

T

T extends ExecutionEventEnum

Parameters

type

T

data

ExecutionEventData[T]

Returns

ExecutionEventImpl<T>


execute()

execute(onComplete?): Promise<void>

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:368

Parameters

onComplete?

(context, eventQueue) => Promise<void>

Returns

Promise<void>


getDebugger()

getDebugger(): DebuggerController | null

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:995

Returns

DebuggerController | null


getOptions()

getOptions(): { breakpoints?: string[]; debug?: boolean; execution?: { flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; }; } | undefined

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:999

Returns

{ breakpoints?: string[]; debug?: boolean; execution?: { flowTimeoutMs?: number; maxConcurrency?: number; nodeTimeoutMs?: number; }; } | undefined


on()

on<T>(type, handler): () => void

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:1003

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/fireflow-types/src/flow/execution-engine.ts:1017

Parameters

handler

(event) => void | Promise<void>

Returns

(): void

Returns

void


setEventCallback()

setEventCallback(callback): void

Defined in: packages/fireflow-types/src/flow/execution-engine.ts:1024

Set a callback to be called when events are emitted

Parameters

callback

(context) => Promise<void>

Returns

void

Licensed under BUSL-1.1