ChainGraph API Documentation / @badaitech/chaingraph-types / TransferEngine

Class: TransferEngine

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:17

Transfer rule engine for managing port connections

Constructors

Constructor

new TransferEngine(rules, options): TransferEngine

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:21

Parameters

rules

TransferRule[] = []

options

TransferEngineOptions = {}

Returns

TransferEngine

Methods

addRule()

addRule(rule): void

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:368

Add a new rule to the engine

Parameters

rule

TransferRule

Returns

void

---

addRules()

addRules(rules): void

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:376

Add multiple rules to the engine

Parameters

rules

TransferRule[]

Returns

void

---

canConnect()

canConnect(sourcePort, targetPort): boolean

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:33

Check if two ports can connect based on transfer rules

Parameters

sourcePort

IPort

targetPort

IPort

Returns

boolean

---

clearRules()

clearRules(): void

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:400

Clear all rules

Returns

void

---

getRules()

getRules(): TransferRule[]

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:393

Get all rules

Returns

TransferRule[]

---

onConnect()

onConnect(sourcePort, targetPort, sourceNode, targetNode): Promise<TransferResult>

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:66

Execute when a new connection is created

Parameters

sourcePort

IPort

targetPort

IPort

sourceNode

INode

targetNode

INode

Returns

Promise<TransferResult>

---

onDisconnect()

onDisconnect(sourcePort, targetPort, sourceNode, targetNode): Promise<TransferResult>

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:155

Execute when a connection is removed

Parameters

sourcePort

IPort

targetPort

IPort

sourceNode

INode

targetNode

INode

Returns

Promise<TransferResult>

---

onSourceUpdate()

onSourceUpdate(sourcePort, targetPort, sourceNode, targetNode): Promise<TransferResult>

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:233

Execute when source port updates on existing connection

Parameters

sourcePort

IPort

targetPort

IPort

sourceNode

INode

targetNode

INode

Returns

Promise<TransferResult>

---

removeRule()

removeRule(name): boolean

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:384

Remove a rule by name

Parameters

name

string

Returns

boolean

---

rule()

static rule(name): RuleBuilder

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:439

Create a rule builder for fluent API

Parameters

name

string

Returns

RuleBuilder