Merge pull request #2615 from Kitware/fix-edgelocator-ts

docs(EdgeLocator): fix parse and update types

Author: floryst

Sources/Common/DataModel/EdgeLocator/index.d.ts

@@ -1,10 +1,18 @@
+import { Nullable } from "../../../types";
+
 /**
  *
  */
 export interface IEdgeLocatorInitialValues {
 	oriented?: boolean;
 }
 
+export interface IEdge<T = unknown> {
+	key: number;
+	edgeId: number;
+	value?: T;
+}
+
 export interface vtkEdgeLocator {
 	/**
 	 * Remove all the edges previously added.
@@ -15,26 +23,22 @@ export interface vtkEdgeLocator {
 	 * Returns the inserted edge or null if no edge was inserted.
 	 * @param {Number} pointId0 Edge first point id
 	 * @param {Number} pointId1 Edge last point id
-	 * @return {key, edgeId, value} or null
+	 * @return {IEdge|null} an edge object ({ key, edgeId, value }) or null
 	 */
-	isInsertedEdge(pointId0: number, pointId1: number): { key: any; edgeId: number; value?: any } | null;
+	isInsertedEdge<T = unknown>(pointId0: number, pointId1: number): Nullable<IEdge<T>>;
 
 	/**
 	 * Insert edge if it does not already exist.
 	 * Returns the existing or newly inserted edge.
 	 *
 	 * @param {Number} pointId0 Edge first point id
 	 * @param {Number} pointId1 Edge last point id
-	 * @param {any} value Optional value option
-	 * @return {key, edgeId, value}
+	 * @param {unknown} value Optional value option
+	 * @return {IEdge|null} an edge object ({ key, edgeId, value }) or null
 	 * @see insertEdge()
 	 * @see isInsertedEdge()
 	 */
-	insertUniqueEdge(
-		pointId0: number,
-		pointId1: number,
-		value?: any
-	): { key: any; edgeId: number; value?: any };
+	insertUniqueEdge<T>(pointId0: number, pointId1: number, value?: T): IEdge<T>;
 
 	/**
 	 * Insert edge. If the edge already exists, it is overwritten by this
@@ -43,15 +47,12 @@ export interface vtkEdgeLocator {
 	 * Returns the newly inserted edge.
 	 * @param {Number} pointId0 Edge first point id
 	 * @param {Number} pointId1 Edge last point id
-	 * @param {any} value Optional value option
-	 * @return {key, edgeId, value} or null
+	 * @param {unknown} value Optional value option
+	 * @return {Edge|null} an edge object ({ key, edgeId, value }) or null
 	 * @see isInsertedEdge
 	 * @see insertUniqueEdge
 	 */
-	insertEdge(pointId0: number,
-		pointId1: number,
-		value?: any
-	): { key: any; edgeId: number; value?: any };
+	insertEdge<T>(pointId0: number, pointId1: number, value?: T): IEdge<T>;
 }
 
 // ----------------------------------------------------------------------------

Sources/Common/DataModel/EdgeLocator/index.js

@@ -30,7 +30,6 @@ class EdgeLocator {
   insertEdge(pointId0, pointId1, newEdgeValue) {
     // Generate a unique key
     const key = this.computeEdgeKey(pointId0, pointId1);
-    // Didn't find key, so add a new edge entry
     const node = { key, edgeId: this.edgeMap.size, value: newEdgeValue };
     this.edgeMap.set(key, node);
     return node;