Finished TSDocs for util functions in React

This commit is contained in:
Peter
2023-12-05 13:46:59 +01:00
parent b264c11c54
commit 95dfd1d6de
2 changed files with 11 additions and 3 deletions

View File

@@ -58,6 +58,14 @@ export const getIncomers = getIncomersBase<Node, Edge>;
*/
export const addEdge = addEdgeBase<Edge>;
/**
* A handy utility to update an existing Edge with new properties
* @param oldEdge - The edge you want to update
* @param newConnection - The new connection you want to update the edge with
* @param edges - The array of all current edges
* @param options.shouldReplaceId - should the id of the old edge be replaced with the new connection id
* @returns the updated edges array
*/
export const updateEdge = updateEdgeBase<Edge>;
/**