Interface GraphSource

packages/graph/src/Graph.ts:110–177

const customInspectSymbol = Symbol.for("nodejs.util.inspect.custom");

export interface GraphSource<TSchema extends GraphSchema> {
  /**
   * The schema of the graph.
   */
  readonly schema: TSchema;

  /**
   * The index manager for query optimization.
   * Optional - sources that don't support indexing can return undefined.
   */
  readonly indexManager?: IndexManager<TSchema>;

  /**
   * Get all incoming edges of a vertex.
   * @param vertexId The id of the vertex.
   */
  getIncomingEdges(vertexId: ElementId): Iterable<Edge<TSchema, any>>;

  /**
   * Get all outgoing edges of a vertex.
   * @param vertexId The id of the vertex.
   */
  getOutgoingEdges(vertexId: ElementId): Iterable<Edge<TSchema, any>>;

  /**
   * Get a specific vertex by its unique identifier.
   * @param id The id of the vertex.
   * @param options.throwIfNotFound If true, throws VertexNotFoundError instead of returning undefined.
   */
  getVertexById<TVertexLabel extends VertexLabel<TSchema>>(
    id: ElementId,
    options: { throwIfNotFound: true },
  ): Vertex<TSchema, TVertexLabel>;
  getVertexById<TVertexLabel extends VertexLabel<TSchema>>(
    id: ElementId,
    options?: { throwIfNotFound?: false },
  ): Vertex<TSchema, TVertexLabel> | undefined;

  /**
   * Get all vertices, optionally filtered by labels.
   * @param labels The labels to filter by.
   */
  getVertices<TVertexLabel extends VertexLabel<TSchema>>(
    ...labels: TVertexLabel[]
  ): Iterable<Vertex<TSchema, TVertexLabel>>;

  /**
   * Get a specific edge by its unique identifier.
   * @param id The id of the edge.
   * @param options.throwIfNotFound If true, throws EdgeNotFoundError instead of returning undefined.
   */
  getEdgeById<TEdgeLabel extends EdgeLabel<TSchema>>(
    id: ElementId,
    options: { throwIfNotFound: true },
  ): Edge<TSchema, TEdgeLabel>;
  getEdgeById<TEdgeLabel extends EdgeLabel<TSchema>>(
    id: ElementId,
    options?: { throwIfNotFound?: false },