From b357f43dfa262205059ac9714198196b4aaf8870 Mon Sep 17 00:00:00 2001
From: Dimitri POSTOLOV <dmytropostolov@gmail.com>
Date: Sat, 5 Apr 2025 17:20:34 +0200
Subject: [PATCH] Improve TSDoc comments for `type UseHandleConnectionsParams`
 and `useHandleConnections` hook

---
 .changeset/many-chefs-clean.md                   |  5 +++++
 packages/react/src/hooks/useHandleConnections.ts | 16 ++++++++--------
 2 files changed, 13 insertions(+), 8 deletions(-)
 create mode 100644 .changeset/many-chefs-clean.md

diff --git a/.changeset/many-chefs-clean.md b/.changeset/many-chefs-clean.md
new file mode 100644
index 00000000..85786317
--- /dev/null
+++ b/.changeset/many-chefs-clean.md
@@ -0,0 +1,5 @@
+---
+'@xyflow/react': patch
+---
+
+Improve TSDoc comments for `type UseHandleConnectionsParams` and `useHandleConnections` hook
diff --git a/packages/react/src/hooks/useHandleConnections.ts b/packages/react/src/hooks/useHandleConnections.ts
index cad87715..a53eb2c7 100644
--- a/packages/react/src/hooks/useHandleConnections.ts
+++ b/packages/react/src/hooks/useHandleConnections.ts
@@ -10,11 +10,16 @@ import {
 import { useStore } from './useStore';
 import { useNodeId } from '../contexts/NodeIdContext';
 
-type useHandleConnectionsParams = {
+type UseHandleConnectionsParams = {
+  /** What type of handle connections do you want to observe? */
   type: HandleType;
+  /** The handle id (this is only needed if the node has multiple handles of the same type). */
   id?: string | null;
+  /** If node id is not provided, the node id from the `NodeIdContext` is used. */
   nodeId?: string;
+  /** Gets called when a connection is established. */
   onConnect?: (connections: Connection[]) => void;
+  /** Gets called when a connection is removed. */
   onDisconnect?: (connections: Connection[]) => void;
 };
 
@@ -23,12 +28,7 @@ type useHandleConnectionsParams = {
  *
  * @public
  * @deprecated Use `useNodeConnections` instead.
- * @param param.type - handle type 'source' or 'target'
- * @param param.nodeId - node id - if not provided, the node id from the NodeIdContext is used
- * @param param.id - the handle id (this is only needed if the node has multiple handles of the same type)
- * @param param.onConnect - gets called when a connection is established
- * @param param.onDisconnect - gets called when a connection is removed
- * @returns an array with handle connections
+ * @returns An array with handle connections.
  */
 export function useHandleConnections({
   type,
@@ -36,7 +36,7 @@ export function useHandleConnections({
   nodeId,
   onConnect,
   onDisconnect,
-}: useHandleConnectionsParams): HandleConnection[] {
+}: UseHandleConnectionsParams): HandleConnection[] {
   console.warn(
     '[DEPRECATED] `useHandleConnections` is deprecated. Instead use `useNodeConnections` https://reactflow.dev/api-reference/hooks/useNodeConnections'
   );