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

Interface: IEdge

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

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

Properties

clone()

clone: () => IEdge

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

Clone the edge

Returns

IEdge

---

dispose()

dispose: () => Promise<void>

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

Dispose of edge resources

Returns

Promise<void>

---

id

readonly id: string

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

Unique identifier of the edge

---

initialize()

initialize: () => Promise<void>

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

Initialize the edge connection

Returns

Promise<void>

---

metadata

readonly metadata: EdgeMetadata

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

Edge metadata

---

sourceNode

readonly sourceNode: INode

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

Source node and port

---

sourcePort

readonly sourcePort: IPort

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

---

status

readonly status: EdgeStatus

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

Current status of the edge

---

targetNode

readonly targetNode: INode

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

Target node and port

---

targetPort

readonly targetPort: IPort

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

---

transfer()

transfer: () => Promise<void>

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

Transfer data from source to target

Returns

Promise<void>

---

updateMetadata()

updateMetadata: (metadata) => void

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

Update edge metadata

Parameters

metadata

Partial<EdgeMetadata>

New metadata

Returns

void

---

validate()

validate: () => Promise<boolean>

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

Validate the edge connection

Returns

Promise<boolean>