PersistentAI API Documentation / @persistent-ai/fireflow-types / FlowPorts

Interface: FlowPorts

Defined in: packages/fireflow-types/src/node/types.ts:124

Type definition for the default node flow ports. Default flow ports include:

• flowIn: boolean (default: true) - Indicates whether the node should be executed
• flowOut: boolean (default: true) - Indicates whether execution was successful
• error: boolean (default: false) - Indicates whether the node execution failed
• errorMessage: string (default: "") - Contains error messages when execution fails

When flow ports are disabled, the node won't appear in the flow visualization and will execute automatically by default. When auto-execution is disabled, the node requires manual triggering.

Properties

disabledAutoExecution?

optional disabledAutoExecution: boolean

Defined in: packages/fireflow-types/src/node/types.ts:133

disabledAutoExecution - boolean, false by default. Indicates flag if the node auto execution is disabled

---

disabledError?

optional disabledError: boolean

Defined in: packages/fireflow-types/src/node/types.ts:149

disabledError - boolean, false by default. Indicates flag if the node error ports are disabled

---

disabledFlowPorts?

optional disabledFlowPorts: boolean

Defined in: packages/fireflow-types/src/node/types.ts:128

disabledFlowPorts - boolean, false by default. Indicates flag if the flow ports are disabled

---

isEventListener?

optional isEventListener: boolean

Defined in: packages/fireflow-types/src/node/types.ts:144

isEventListener - boolean, false by default. When true, the SP-tree planner treats this node as an event listener:

• Detects its event-bound cluster (upstream/downstream nodes)
• In child executions, only executes when context.eventData.eventName matches node.eventName
• Requires disabledAutoExecution: true to work correctly

The node MUST have an eventName: string property for event name matching.

---

portsConfig?

optional portsConfig: object

Defined in: packages/fireflow-types/src/node/types.ts:154

portsConfig - Optional configuration for each system port

error?

optional error: object

error.id?

optional id: string

error.value?

optional value: boolean

errorMessage?

optional errorMessage: object

errorMessage.id?

optional id: string

errorMessage.value?

optional value: string

flowIn?

optional flowIn: object

flowIn.id?

optional id: string

flowIn.value?

optional value: boolean

flowOut?

optional flowOut: object

flowOut.id?

optional id: string

flowOut.value?

optional value: boolean