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

Class: Edge

Defined in: packages/chaingraph-types/src/edge/edge.ts:18

Interface representing an edge in the graph, connecting output ports of one node to input ports of another node.

Implements

• IEdge

Constructors

Constructor

new Edge(id, sourceNode, sourcePort, targetNode, targetPort, metadata): Edge

Defined in: packages/chaingraph-types/src/edge/edge.ts:27

Parameters

id

string

sourceNode

INode

sourcePort

IPort

targetNode

INode

targetPort

IPort

metadata

EdgeMetadata = {}

Returns

Edge

Properties

id

readonly id: string

Defined in: packages/chaingraph-types/src/edge/edge.ts:19

Unique identifier of the edge

Implementation of

IEdge.id

---

metadata

readonly metadata: EdgeMetadata

Defined in: packages/chaingraph-types/src/edge/edge.ts:24

Edge metadata

Implementation of

IEdge.metadata

---

sourceNode

readonly sourceNode: INode

Defined in: packages/chaingraph-types/src/edge/edge.ts:20

Source node and port

Implementation of

IEdge.sourceNode

---

sourcePort

readonly sourcePort: IPort

Defined in: packages/chaingraph-types/src/edge/edge.ts:21

Implementation of

IEdge.sourcePort

---

status

status: EdgeStatus = EdgeStatus.Inactive

Defined in: packages/chaingraph-types/src/edge/edge.ts:25

Current status of the edge

Implementation of

IEdge.status

---

targetNode

readonly targetNode: INode

Defined in: packages/chaingraph-types/src/edge/edge.ts:22

Target node and port

Implementation of

IEdge.targetNode

---

targetPort

readonly targetPort: IPort

Defined in: packages/chaingraph-types/src/edge/edge.ts:23

Implementation of

IEdge.targetPort

Methods

clone()

clone(): IEdge

Defined in: packages/chaingraph-types/src/edge/edge.ts:164

Clone the edge

Returns

IEdge

Implementation of

IEdge.clone

---

dispose()

dispose(): Promise<void>

Defined in: packages/chaingraph-types/src/edge/edge.ts:159

Dispose of edge resources

Returns

Promise<void>

Implementation of

IEdge.dispose

---

initialize()

initialize(): Promise<void>

Defined in: packages/chaingraph-types/src/edge/edge.ts:43

Initialize the edge connection

Returns

Promise<void>

Implementation of

IEdge.initialize

---

transfer()

transfer(): Promise<void>

Defined in: packages/chaingraph-types/src/edge/edge.ts:82

Transfer data from source to target

Returns

Promise<void>

Implementation of

IEdge.transfer

---

updateMetadata()

updateMetadata(metadata): void

Defined in: packages/chaingraph-types/src/edge/edge.ts:155

Update edge metadata

Parameters

metadata

Partial<EdgeMetadata>

New metadata

Returns

void

Implementation of

IEdge.updateMetadata

---

validate()

validate(): Promise<boolean>

Defined in: packages/chaingraph-types/src/edge/edge.ts:60

Validate the edge connection

Returns

Promise<boolean>

Implementation of

IEdge.validate