IAsyncGraph
Defined in: packages/data/src/graph/iasync-graph.ts:4
The async-backed sibling of IGraph.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”N
E extends DefinedValue | void = void
Methods
Section titled “Methods”addEdge()
Section titled “addEdge()”addEdge(
from,to,label,signal?):Promise<void>
Defined in: packages/data/src/graph/iasync-graph.ts:13
Parameters
Section titled “Parameters”N
N
E
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
addNode()
Section titled “addNode()”addNode(
node,signal?):Promise<void>
Defined in: packages/data/src/graph/iasync-graph.ts:7
Parameters
Section titled “Parameters”N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
addNodes()
Section titled “addNodes()”addNodes(
nodes,signal?):Promise<void>
Defined in: packages/data/src/graph/iasync-graph.ts:8
Parameters
Section titled “Parameters”Iterable<N>
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<void>
degree()
Section titled “degree()”degree(
node,signal?):Promise<number>
Defined in: packages/data/src/graph/iasync-graph.ts:20
Parameters
Section titled “Parameters”N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<number>
deleteEdge()
Section titled “deleteEdge()”deleteEdge(
from,to,signal?):Promise<boolean>
Defined in: packages/data/src/graph/iasync-graph.ts:14
Parameters
Section titled “Parameters”N
N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
deleteNode()
Section titled “deleteNode()”deleteNode(
node,signal?):Promise<boolean>
Defined in: packages/data/src/graph/iasync-graph.ts:9
Parameters
Section titled “Parameters”N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
edgeCount()
Section titled “edgeCount()”edgeCount(
signal?):Promise<number>
Defined in: packages/data/src/graph/iasync-graph.ts:6
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<number>
edgeLabel()
Section titled “edgeLabel()”edgeLabel(
from,to,signal?):Promise<E|undefined>
Defined in: packages/data/src/graph/iasync-graph.ts:16
Parameters
Section titled “Parameters”N
N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<E | undefined>
edges()
Section titled “edges()”edges(
signal?):AsyncIterableIterator<readonly [N,N,E]>
Defined in: packages/data/src/graph/iasync-graph.ts:17
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<readonly [N, N, E]>
hasEdge()
Section titled “hasEdge()”hasEdge(
from,to,signal?):Promise<boolean>
Defined in: packages/data/src/graph/iasync-graph.ts:15
Parameters
Section titled “Parameters”N
N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
hasNode()
Section titled “hasNode()”hasNode(
node,signal?):Promise<boolean>
Defined in: packages/data/src/graph/iasync-graph.ts:10
Parameters
Section titled “Parameters”N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<boolean>
neighbors()
Section titled “neighbors()”neighbors(
node,signal?):AsyncIterableIterator<N>
Defined in: packages/data/src/graph/iasync-graph.ts:19
Parameters
Section titled “Parameters”N
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<N>
nodeCount()
Section titled “nodeCount()”nodeCount(
signal?):Promise<number>
Defined in: packages/data/src/graph/iasync-graph.ts:5
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<number>
nodes()
Section titled “nodes()”nodes(
signal?):AsyncIterableIterator<N>
Defined in: packages/data/src/graph/iasync-graph.ts:11
Parameters
Section titled “Parameters”signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”AsyncIterableIterator<N>