Skip to content

@graphty/graphty-element / session / EdgeMember

Interface: EdgeMember ​

Defined in: graphty-element/src/catalog/types.ts:1112

An edge member, by its stable identity: the endpoints plus exactly one discriminator, id, key or the pair ordinal and among. The validator refuses any other combination.

OPEN: may gain optional members in a minor release.

Properties ​

among? ​

readonly optional among?: number

Defined in: graphty-element/src/catalog/types.ts:1131

That pair's edge count in that load. Present with ordinal or not at all.


id? ​

readonly optional id?: string | number

Defined in: graphty-element/src/catalog/types.ts:1121

The file's edge id, read at the element's configured edgeIdPath, or for an edge added in the session without one, the id the element minted for it (graphty:e<n>).


key? ​

readonly optional key?: string | number

Defined in: graphty-element/src/catalog/types.ts:1123

The file's parallel-edge key. Reserved: refused until the element reads one.


ordinal? ​

readonly optional ordinal?: number

Defined in: graphty-element/src/catalog/types.ts:1129

Last resort, for a file edge without an id: the edge's position, counting from 0, among every edge of its pair in the load that ingested it, in ingest order. Present with among or not at all.


source ​

readonly source: NodeId

Defined in: graphty-element/src/catalog/types.ts:1114

The node the edge leaves, as loaded.


target ​

readonly target: NodeId

Defined in: graphty-element/src/catalog/types.ts:1116

The node the edge enters, as loaded.