fix: turn shouldFollow arguments into a single object argument

Author: JesusTheHun

src/algorithms/depthFirstSearch/depthFirstSearch.spec.ts

@@ -12,7 +12,7 @@ describe('depthFirstSearch', () => {
     graph.addEdge('b', 'e', undefined, { type: 'foo' });
 
     const nodes = depthFirstSearch(graph, {
-      shouldFollow: (source, target, graph) =>
+      shouldFollow: ({ source, target, graph }) =>
         graph.getEdgeProperties(source, target).type === 'foo',
     });
 

src/algorithms/depthFirstSearch/depthFirstVisit.ts

@@ -22,7 +22,8 @@ export function depthFirstVisit<Node, LinkProps>(
     visiting.add(node);
 
     graph.adjacent(node)?.forEach((n) => {
-      const follow = shouldFollow === undefined || shouldFollow(node, n, graph);
+      const follow =
+        shouldFollow === undefined || shouldFollow({ source: node, target: n, graph });
       if (!follow) return;
 
       depthFirstVisit(graph, nodeList, visited, visiting, n, opts);

src/algorithms/depthFirstSearch/types.ts

@@ -27,9 +27,9 @@ export type DepthFirstSearchOptions<Node, LinkProps> = {
    * @param graph the graph instance being explored
    * @returns boolean
    */
-  shouldFollow?: (
-    source: NoInfer<Node>,
-    target: NoInfer<Node>,
-    graph: Graph<Node, LinkProps>,
-  ) => boolean;
+  shouldFollow?: (args: {
+    source: NoInfer<Node>;
+    target: NoInfer<Node>;
+    graph: Graph<Node, LinkProps>;
+  }) => boolean;
 };

src/algorithms/topologicalSort/topologicalSort.spec.ts

@@ -81,7 +81,7 @@ describe('topologicalSort', () => {
     const sorted = topologicalSort(graph, {
       sourceNodes: ['a'],
       includeSourceNodes: true,
-      shouldFollow: (source, target) =>
+      shouldFollow: ({ source, target }) =>
         graph.getEdgeProperties(source, target).type === 'foo',
     });
 

src/algorithms/topologicalSort/topologicalSort.ts

@@ -28,11 +28,11 @@ export type TopologicalSortOptions<Node, LinkProps> = {
    * @param graph the graph instance being explored
    * @returns boolean
    */
-  shouldFollow?: (
-    source: NoInfer<Node>,
-    target: NoInfer<Node>,
-    graph: Graph<Node, LinkProps>,
-  ) => boolean;
+  shouldFollow?: (args: {
+    source: NoInfer<Node>;
+    target: NoInfer<Node>;
+    graph: Graph<Node, LinkProps>;
+  }) => boolean;
 };
 
 export function topologicalSort<Node, LinkProps>(

src/utils/hasCycle.spec.ts

@@ -52,7 +52,7 @@ describe('hasCycle', () => {
 
     expect(
       hasCycle(graph, {
-        shouldFollow: (source, target) =>
+        shouldFollow: ({ source, target }) =>
           graph.getEdgeProperties(source, target) === 'foo',
       }),
     ).toBe(false);