Method addEdge

packages/graph/src/Graph.ts:591–643

(...args: any[])

    properties: EdgeProperties<TSchema, TEdgeLabel>,
  ): Edge<TSchema, TEdgeLabel>;
  public addEdge(...args: any[]) {
    let rawOutV: Vertex<TSchema, any> | ElementId;
    let label: EdgeLabel<TSchema>;
    let rawInV: Vertex<TSchema, any> | ElementId;
    let properties: EdgeProperties<TSchema, any>;
    if (args.length === 1 && typeof args[0] === "object" && args[0] !== null) {
      ({ outV: rawOutV, label, inV: rawInV, properties } = args[0]);
    } else {
      [rawOutV, label, rawInV, properties] = args;
    }

    // Validate and transform properties when validation is enabled
    const validateProperties = this.#config.validateProperties ?? true;
    if (validateProperties) {
      const schemaProperties = this.#config.schema.edges[label]?.properties;
      properties = parseProperties(label, properties, schemaProperties);
    }

    const id = this.generateElementId(label);

    const outV = typeof rawOutV === "object" ? rawOutV : this.getVertexById(rawOutV);
    const inV = typeof rawInV === "object" ? rawInV : this.getVertexById(rawInV);

    if (outV == null) {
      throw new VertexNotFoundError(rawOutV as ElementId);
    }
    if (inV == null) {
      throw new VertexNotFoundError(rawInV as ElementId);
    }
    const data: StoredEdge = {
      "@type": "Edge",
      id,
      properties,
      inV: inV.id,
      outV: outV.id,
    };

    // Ensure unique indexes are built before checking constraints
    this.#indexManager.ensureUniqueIndexesBuilt(label, this.#config.storage.getEdges([label]));

    // Check unique constraints before adding (throws if violated)
    this.#indexManager.checkAllUniqueConstraints(label, properties);

    // Add to storage
    this.#config.storage.addEdge(data);

    // Add to indexes
    this.#indexManager.onElementAdd(data);

    const edge = this.instantiateEdge(data);

    return edge;
  }

  /**
   * Delete an edge from the graph.