AIDK API Reference / aidk-kernel / ProcedureNode

Class: ProcedureNode

Defined in: packages/kernel/src/procedure-graph.ts:9

Procedure node stored in the graph

Constructors

Constructor

new ProcedureNode(
   graph: ProcedureGraph, 
   pid: string, 
   parentPid?: string, 
   name?: string, 
   metadata?: Record<string, any>, 
   executionId?: string, 
   isExecutionBoundary?: boolean, 
   executionType?: string): ProcedureNode;

Defined in: packages/kernel/src/procedure-graph.ts:28

Parameters

Parameter	Type
graph	ProcedureGraph
pid	string
parentPid?	string
name?	string
metadata?	Record<string, any>
executionId?	string
isExecutionBoundary?	boolean
executionType?	string

Returns

ProcedureNode

Properties

Property	Modifier	Type	Default value	Defined in
completedAt?	public	Date	undefined	packages/kernel/src/procedure-graph.ts:15
error?	public	Error	undefined	packages/kernel/src/procedure-graph.ts:16
executionId	readonly	string	undefined	packages/kernel/src/procedure-graph.ts:24
executionType?	readonly	string	undefined	packages/kernel/src/procedure-graph.ts:26
graph	readonly	ProcedureGraph	undefined	packages/kernel/src/procedure-graph.ts:18
isExecutionBoundary	readonly	boolean	undefined	packages/kernel/src/procedure-graph.ts:25
metadata?	public	Record<string, any>	undefined	packages/kernel/src/procedure-graph.ts:17
metrics	public	Record<string, number>	{}	packages/kernel/src/procedure-graph.ts:21
name?	readonly	string	undefined	packages/kernel/src/procedure-graph.ts:12
parentPid?	readonly	string	undefined	packages/kernel/src/procedure-graph.ts:11
pid	readonly	string	undefined	packages/kernel/src/procedure-graph.ts:10
startedAt	readonly	Date	undefined	packages/kernel/src/procedure-graph.ts:14
status	public	ProcedureStatus	undefined	packages/kernel/src/procedure-graph.ts:13

Accessors

durationMs

Get Signature

get durationMs(): number | undefined;

Defined in: packages/kernel/src/procedure-graph.ts:100

Get duration in milliseconds (undefined if not completed)

Returns

number | undefined

Methods

addMetric()

addMetric(key: string, value: number): void;

Defined in: packages/kernel/src/procedure-graph.ts:54

Add metric value (accumulates)

Parameters

Parameter	Type
key	string
value	number

Returns

void

---

cancel()

cancel(): void;

Defined in: packages/kernel/src/procedure-graph.ts:92

Returns

void

---

complete()

complete(): void;

Defined in: packages/kernel/src/procedure-graph.ts:81

Returns

void

---

fail()

fail(error: Error): void;

Defined in: packages/kernel/src/procedure-graph.ts:86

Parameters

Parameter	Type
error	Error

Returns

void

---

getChildrenNodes()

getChildrenNodes(): ProcedureNode[];

Defined in: packages/kernel/src/procedure-graph.ts:111

Returns

ProcedureNode[]

---

getMetric()

getMetric(key: string): number;

Defined in: packages/kernel/src/procedure-graph.ts:68

Get metric value

Parameters

Parameter	Type
key	string

Returns

number

---

getParentNode()

getParentNode(): ProcedureNode | undefined;

Defined in: packages/kernel/src/procedure-graph.ts:107

Returns

ProcedureNode | undefined

---

hasAncestor()

hasAncestor(predicate: (node: ProcedureNode) => boolean): boolean;

Defined in: packages/kernel/src/procedure-graph.ts:115

Parameters

Parameter	Type
predicate	(node: ProcedureNode) => boolean

Returns

boolean

---

mergeMetrics()

mergeMetrics(sourceMetrics: Record<string, number>): void;

Defined in: packages/kernel/src/procedure-graph.ts:75

Merge metrics from another node (for propagation)

Parameters

Parameter	Type
sourceMetrics	Record<string, number>

Returns

void

---

setMetric()

setMetric(key: string, value: number): void;

Defined in: packages/kernel/src/procedure-graph.ts:61

Set metric value (overwrites)

Parameters

Parameter	Type
key	string
value	number

Returns

void