Added some more TSDocs for util functions

2023-12-05 13:35:12 +01:00
parent 4accceb202
commit b264c11c54
6 changed files with 128 additions and 2 deletions
@@ -208,6 +208,12 @@ export const getNodesInside = <NodeType extends NodeBase>(
  return visibleNodes;
 };

+/**
+ * Get all connecting edges for a given set of nodes
+ * @param nodes - Nodes you want to get the connected edges for
+ * @param edges - All edges
+ * @returns Array of edges that connect any of the given nodes with each other
+ */
 export const getConnectedEdgesBase = <NodeType extends NodeBase = NodeBase, EdgeType extends EdgeBase = EdgeBase>(
  nodes: NodeType[],
  edges: EdgeType[]