🤖 Merge PR DefinitelyTyped#73953 fix: linkSort and nodeSort argument typing by @alexfauquette

Author: alexfauquette

types/d3-sankey/d3-sankey-tests.ts

@@ -278,17 +278,19 @@ num = slgDAG.iterations();
 
 // test multiple definitions
 slgDAG = slgDAG.nodeSort((node: SNode) => (node.index === 0 ? 1 : -1));
-slgDAG = slgDAG.nodeSort(() => undefined);
-slgDAG = slgDAG.nodeSort((node: SNode) => (node.name === "test" ? null : undefined));
+slgDAG = slgDAG.nodeSort(undefined);
+slgDAG = slgDAG.nodeSort(null);
+slgDAG = slgDAG.nodeSort((node: SNode) => (node.name === "test" ? 0 : -1));
 
 // ---------------------------------------------------------------------------
 // LinkSort
 // ---------------------------------------------------------------------------
 
 // test multiple definitions
 slgDAG = slgDAG.linkSort((link: SLink) => (link.index === 0 ? 1 : -1));
-slgDAG = slgDAG.linkSort(() => undefined);
-slgDAG = slgDAG.linkSort((link: SLink) => (link.source > link.target ? null : undefined));
+slgDAG = slgDAG.linkSort(undefined);
+slgDAG = slgDAG.linkSort(null);
+slgDAG = slgDAG.linkSort((link: SLink) => (link.source > link.target ? 0 : -1));
 
 // ---------------------------------------------------------------------------
 // Node Id

types/d3-sankey/index.d.ts

@@ -341,26 +341,26 @@ export interface SankeyLayout<Data, N extends SankeyExtraProperties, L extends S
     /**
      * Returns the node comparison function which defaults to undefined.
      */
-    nodeSort(): ((a: SankeyNode<N, L>, b: SankeyNode<N, L>) => number) | undefined;
+    nodeSort(): ((a: SankeyNode<N, L>, b: SankeyNode<N, L>) => number) | undefined | null;
 
     /**
      * Set the node comparison function and return this Sankey layout generator.
      *
-     * @param compare Node comparison function.
+     * @param compare Node comparison function. If `null`, the order is fixed by the input.
      */
-    nodeSort(compare: (a: SankeyNode<N, L>, b: SankeyNode<N, L>) => number | undefined | null): this;
+    nodeSort(compare: ((a: SankeyNode<N, L>, b: SankeyNode<N, L>) => number) | undefined | null): this;
 
     /**
      * Returns the link comparison function which defaults to undefined.
      */
-    linkSort(): ((a: SankeyLink<N, L>, b: SankeyLink<N, L>) => number) | undefined;
+    linkSort(): ((a: SankeyLink<N, L>, b: SankeyLink<N, L>) => number) | undefined | null;
 
     /**
      * Set the link comparison function and return this Sankey layout generator.
      *
-     * @param compare Link comparison function.
+     * @param compare Link comparison function. If `null`, the order is fixed by the input.
      */
-    linkSort(compare: (a: SankeyLink<N, L>, b: SankeyLink<N, L>) => number | undefined | null): this;
+    linkSort(compare: ((a: SankeyLink<N, L>, b: SankeyLink<N, L>) => number) | undefined | null): this;
 }
 
 /**