Function getGraphEdgesOfType

getGraphEdgesOfType<TGraph, TTypes>(graph, types?): GetGraphEdgesOfTypesResult<TGraph, TTypes>
Retrieves the edges of a graph based on the specified types.
Type Parameters
- TGraph extends GraphWithTypeForEdge
  The type of the graph.
- TTypes extends string | TypesObjectForEdge<TGraph> | TypesArrayForEdge<TGraph>
  The type of the edge types.
Parameters
- graph: TGraph
  The graph to retrieve the edges from.
- Optional types: TTypes
  The specific types to filter the edges by.
Returns GetGraphEdgesOfTypesResult<TGraph, TTypes>
- The edges of the graph that match the specified types.
Throws
- If the arguments are invalid.
- Defined in src/edges/getGraphEdgesOfType.ts:56
getGraphEdgesOfType<TGraph, TTypes>(graph, node, types): GetGraphEdgesOfTypesResult<TGraph, TTypes>
Type Parameters
- TGraph extends GraphWithTypeForEdge
- TTypes extends string | TypesArrayForEdge<TGraph> | TypesObjectForEdge<TGraph>
Parameters
- graph: TGraph
- node: string
- types: TTypes
Returns GetGraphEdgesOfTypesResult<TGraph, TTypes>
- Defined in src/edges/getGraphEdgesOfType.ts:61
getGraphEdgesOfType<TGraph, TTypes>(graph, node, neighbor, types): GetGraphEdgesOfTypesResult<TGraph, TTypes>
Type Parameters
- TGraph extends GraphWithTypeForEdge
- TTypes extends string | TypesArrayForEdge<TGraph> | TypesObjectForEdge<TGraph>
Parameters
- graph: TGraph
- node: string
- neighbor: string
- types: TTypes
Returns GetGraphEdgesOfTypesResult<TGraph, TTypes>
- Defined in src/edges/getGraphEdgesOfType.ts:70

Generated using TypeDoc