@xyflow/svelte
Version:
Svelte Flow - A highly customizable Svelte library for building node-based editors, workflow systems, diagrams and more.
16 lines (15 loc) • 847 B
TypeScript
import { type NodeConnection, type UseNodeConnectionsParams } from '@xyflow/system';
/**
* Hook to retrieve all edges connected to a node. Can be filtered by handle type and id.
*
* @public
* @param param.id - node id - optional if called inside a custom node
* @param param.handleType - filter by handle type 'source' or 'target'
* @param param.handleId - filter by handle id (this is only needed if the node has multiple handles of the same type). Requires `handleType` to be set.
* @param param.onConnect - gets called when a connection is established
* @param param.onDisconnect - gets called when a connection is removed
* @returns An array with connections
*/
export declare function useNodeConnections({ id, handleType, handleId, onConnect, onDisconnect }?: UseNodeConnectionsParams): {
readonly current: NodeConnection[];
};