chore(utils): tsdoc update

packages/react/src/utils/changes.ts

@@ -153,7 +153,14 @@ function applyChange(change: any, element: any): any {
  * @param nodes - Array of nodes to apply the changes to
  * @returns Array of updated nodes
  * @example
- *  const onNodesChange = useCallback(
+ *```tsx
+ *import { useState, useCallback } from 'react';
+ *import { ReactFlow, applyNodeChanges, type Node, type Edge, type OnNodesChange } from '@xyflow/react';
+ *
+ *export default function Flow() {
+ *  const [nodes, setNodes] = useState<Node[]>([]);
+ *  const [edges, setEdges] = useState<Edge[]>([]);
+ *  const onNodesChange: OnNodesChange = useCallback(
  *    (changes) => {
  *      setNodes((oldNodes) => applyNodeChanges(changes, oldNodes));
  *    },
@@ -161,8 +168,10 @@ function applyChange(change: any, element: any): any {
  *  );
  *
  *  return (
- *    <ReactFLow nodes={nodes} edges={edges} onNodesChange={onNodesChange} />
+ *    <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} />
  *  );
+ *}
+ *```
  */
 export function applyNodeChanges<NodeType extends Node = Node>(
   changes: NodeChange<NodeType>[],
@@ -180,6 +189,14 @@ export function applyNodeChanges<NodeType extends Node = Node>(
  * @param edges - Array of edge to apply the changes to
  * @returns Array of updated edges
  * @example
+ *
+ * ```tsx
+ *import { useState, useCallback } from 'react';
+ *import { ReactFlow, applyEdgeChanges } from '@xyflow/react';
+ *
+ *export default function Flow() {
+ *  const [nodes, setNodes] = useState([]);
+ *  const [edges, setEdges] = useState([]);
  *  const onEdgesChange = useCallback(
  *    (changes) => {
  *      setEdges((oldEdges) => applyEdgeChanges(changes, oldEdges));
@@ -190,6 +207,8 @@ export function applyNodeChanges<NodeType extends Node = Node>(
  *  return (
  *    <ReactFlow nodes={nodes} edges={edges} onEdgesChange={onEdgesChange} />
  *  );
+ *}
+ *```
  */
 export function applyEdgeChanges<EdgeType extends Edge = Edge>(
   changes: EdgeChange<EdgeType>[],

packages/react/src/utils/general.ts

@@ -4,21 +4,43 @@ import { isNodeBase, isEdgeBase } from '@xyflow/system';
 import type { Edge, Node } from '../types';
 
 /**
- * Test whether an object is useable as a Node
+ * Test whether an object is useable as an [`Node`](/api-reference/types/node). In TypeScript
+ *this is a type guard that will narrow the type of whatever you pass in to
+ *[`Node`](/api-reference/types/node) if it returns `true`.
  * @public
  * @remarks In TypeScript this is a type guard that will narrow the type of whatever you pass in to Node if it returns true
  * @param element - The element to test
  * @returns A boolean indicating whether the element is an Node
+ *
+ * @example
+ * ```js
+ *import { isNode } from '@xyflow/react';
+ *
+ *if (isNode(node)) {
+ * // ..
+ *}
+ *```
  */
 export const isNode = <NodeType extends Node = Node>(element: unknown): element is NodeType =>
   isNodeBase<NodeType>(element);
 
 /**
- * Test whether an object is useable as an Edge
+ * Test whether an object is useable as an [`Edge`](/api-reference/types/edge). In TypeScript
+ *this is a type guard that will narrow the type of whatever you pass in to
+ *[`Edge`](/api-reference/types/edge) if it returns `true`.
  * @public
  * @remarks In TypeScript this is a type guard that will narrow the type of whatever you pass in to Edge if it returns true
  * @param element - The element to test
  * @returns A boolean indicating whether the element is an Edge
+ *
+ * @example
+ * ```js
+ *import { isEdge } from '@xyflow/react';
+ *
+ *if (isEdge(edge)) {
+ * // ..
+ *}
+ *```
  */
 export const isEdge = <EdgeType extends Edge = Edge>(element: unknown): element is EdgeType =>
   isEdgeBase<EdgeType>(element);