Merge pull request #5167 from dimaMachina/tsdoc2-13

Improve TSDoc comments for `useEdges`, `useInternalNode`, `useNodes` and `useNodeId` hooks

.changeset/gorgeous-hats-count.md

@@ -0,0 +1,5 @@
+---
+'@xyflow/react': patch
+---
+
+Improve TSDoc comments for `useEdges`, `useInternalNode`, `useNodes` and `useNodeId` hooks

packages/react/src/contexts/NodeIdContext.ts

@@ -10,7 +10,7 @@ export const Consumer = NodeIdContext.Consumer;
  * drill down the id as a prop.
  *
  * @public
- * @returns id of the node
+ * @returns The id for a node in the flow.
  *
  * @example
  *```jsx

packages/react/src/hooks/useEdges.ts

@@ -10,7 +10,7 @@ const edgesSelector = (state: ReactFlowState) => state.edges;
  * will re-render **whenever any edge changes**.
  *
  * @public
- * @returns An array of edges
+ * @returns An array of all edges currently in the flow.
  *
  * @example
  * ```tsx

packages/react/src/hooks/useInternalNode.ts

@@ -10,8 +10,8 @@ import type { InternalNode, Node } from '../types';
  * including when a node is selected or moved.
  *
  * @public
- * @param id - id of the node
+ * @param id - The ID of a node you want to observe.
- * @returns array with visible node ids
+ * @returns The `InternalNode` object for the node with the given ID.
  *
  * @example
  * ```tsx

packages/react/src/hooks/useNodes.ts

@@ -11,7 +11,7 @@ const nodesSelector = (state: ReactFlowState) => state.nodes;
  * or moved.
  *
  * @public
- * @returns An array of nodes
+ * @returns An array of all nodes currently in the flow.
  *
  * @example
  * ```jsx