Class Edge

Readonlydatabase

getEdgeType

• getEdgeType(): EdgeType

• Returns EdgeType

getEffective

• getEffective(asOf?: AsOf): Promise<number>

• Parameters

  • OptionalasOf: AsOf

  Returns Promise<number>

getSourceVertex

• getSourceVertex(): Vertex

• Returns Vertex

getTargetVertex

• getTargetVertex(): Vertex

• Returns Vertex

getValue

• getValue(): Value

• Returns Value

isAlive

• isAlive(asOf?: AsOf): Promise<boolean>

• NOTE: If this edge has been removed, or if its edgeType has been reset, this method will ALWAYS return false. If its edgeType has been reset, it has been replaced with a new edge that has the exact same source, target, value, and properties. Check getEdgesTo and getEdgesFrom on the source and target vertices to find replaced edges.

  Parameters

  • OptionalasOf: AsOf

  Returns Promise<boolean>

remove

• remove(dest?: number, purge?: boolean, meta?: Meta): Promise<void>

• If dest is not provided (or 0), the edge will be removed. This exact edge with the same Muid will never exist again. The only way to "revive" it is to reset the database or its edgeType. In that case, a new edge will be created with the same source, target, value, and properties.

  Parameters

  • Optionaldest: number

    a timestamp to move the edge to. If 0 or not specified, the edge will be removed.
  • Optionalpurge: boolean

    completely remove the edge's entry from the datastore?
  • Optionalmeta: Meta

    optional metadata (may contain: comment, identity, or bundler)

  Returns Promise<void>

Staticget

• get(database: Database, muid: Muid, data: EdgeData): Edge

• Parameters

  • database: Database
  • muid: Muid
  • data: EdgeData

  Returns Edge

Staticload

• load(database: Database, address: Muid): Promise<Edge>

• Parameters

  • database: Database
  • address: Muid

  Returns Promise<Edge>