Merge pull request #5354 from xyflow/chore/ts-docs-comments

chore(libs): add tsdoc annotations

.changeset/fifty-rings-perform.md

@@ -0,0 +1,7 @@
+---
+'@xyflow/react': patch
+'@xyflow/svelte': patch
+'@xyflow/system': patch
+---
+
+Add TSDoc annotations

packages/react/src/types/general.ts

@@ -99,6 +99,9 @@ export type OnSelectionChangeFunc<NodeType extends Node = Node, EdgeType extends
   params: OnSelectionChangeParams<NodeType, EdgeType>
 ) => void;
 
+/**
+ * @inline
+ */
 export type FitViewParams<NodeType extends Node = Node> = FitViewParamsBase<NodeType>;
 
 /**
@@ -107,9 +110,18 @@ export type FitViewParams<NodeType extends Node = Node> = FitViewParamsBase<Node
  * transform the viewport smoothly over a given amount of time.
  *
  * @public
+ * @inline
  */
 export type FitViewOptions<NodeType extends Node = Node> = FitViewOptionsBase<NodeType>;
+
+/**
+ * @inline
+ */
 export type FitView<NodeType extends Node = Node> = (fitViewOptions?: FitViewOptions<NodeType>) => Promise<boolean>;
+
+/**
+ * @inline
+ */
 export type OnInit<NodeType extends Node = Node, EdgeType extends Edge = Edge> = (
   reactFlowInstance: ReactFlowInstance<NodeType, EdgeType>
 ) => void;
@@ -209,4 +221,8 @@ export type OnBeforeDelete<NodeType extends Node = Node, EdgeType extends Edge =
   EdgeType
 >;
 
+/**
+ *  This type can be used to type the `isValidConnection` function.
+ *  If the function returns `true`, the connection is valid and can be created.
+ */
 export type IsValidConnection<EdgeType extends Edge = Edge> = (edge: EdgeType | Connection) => boolean;

packages/svelte/src/lib/types/general.ts

@@ -21,8 +21,16 @@ export type ConnectionData = {
   connectionStatus: string | null;
 };
 
+/**
+ * @inline
+ */
 export type FitViewOptions<NodeType extends Node = Node> = FitViewOptionsBase<NodeType>;
 
+/**
+ * This type can be used to type the `onDelete` function with a custom node and edge type.
+ *
+ * @public
+ */
 export type OnDelete<NodeType extends Node = Node, EdgeType extends Edge = Edge> = (params: {
   nodes: NodeType[];
   edges: EdgeType[];
@@ -40,6 +48,10 @@ export type OnBeforeDelete<
   EdgeType extends Edge = Edge
 > = OnBeforeDeleteBase<NodeType, EdgeType>;
 
+/**
+ *  This type can be used to type the `isValidConnection` function.
+ *  If the function returns `true`, the connection is valid and can be created.
+ */
 export type IsValidConnection<EdgeType extends Edge = Edge> = (
   edge: EdgeType | Connection
 ) => boolean;

packages/system/src/types/general.ts

@@ -13,13 +13,28 @@ import { EdgeBase } from '..';
 
 export type Project = (position: XYPosition) => XYPosition;
 
+/**
+ * This type is used to define the `onMove` handler.
+ */
 export type OnMove = (event: MouseEvent | TouchEvent | null, viewport: Viewport) => void;
 export type OnMoveStart = OnMove;
 export type OnMoveEnd = OnMove;
 
+/**
+ * @inline
+ */
 export type ZoomInOut = (options?: ViewportHelperFunctionOptions) => Promise<boolean>;
+/**
+ * @inline
+ */
 export type ZoomTo = (zoomLevel: number, options?: ViewportHelperFunctionOptions) => Promise<boolean>;
+/**
+ * @inline
+ */
 export type GetZoom = () => number;
+/**
+ * @inline
+ */
 export type GetViewport = () => Viewport;
 
 /**