isEdge()

Source on GitHub

Test whether an object is usable as an Edge. In TypeScript this is a type guard that will narrow the type of whatever you pass in to Edge if it returns true.


import { isEdge } from '@xyflow/react';
 
const edge = {
  id: 'edge-a',
  source: 'a',
  target: 'b',
};
 
if (isEdge(edge)) {
  // ...
}

Signature

Parameters:

Name	Type	Default
`element`	`unknown` The element to test

Returns:

boolean

Tests whether the provided value can be used as an Edge. If you’re using TypeScript, this function acts as a type guard and will narrow the type of the value to Edge if it returns true.